Automake第二篇 automake教程

Automake UsersGuide

1. 创建Demo工作空间

mkdir automake_demo
cd automake_demo/
touch hello.c
vim hello.c

2. 插入基本C语言代码

#include <stdio.h>

int main(int argc, char** argv)
{
 	printf("Hello, Linux World!
");
 	return 0;
}

3. 使用autoscan命令生成configure.scan文件

查看configure.scan内容 cat configure.scan

#                                               -*- Autoconf -*-
# Process this file with autoconf to produce a configure script.

AC_PREREQ([2.69])
AC_INIT([FULL-PACKAGE-NAME], [VERSION], [BUG-REPORT-ADDRESS])
AC_CONFIG_SRCDIR([hello.c])
AC_CONFIG_HEADERS([config.h])

# Checks for programs.
AC_PROG_CC

# Checks for libraries.

# Checks for header files.

# Checks for typedefs, structures, and compiler characteristics.

# Checks for library functions.

AC_OUTPUT

• AC_PREREQQ宏声明本文件要求的autoconf版本，这里是2.69
• AC_INIT定义软件的名称和信息。(DULL-PACKAGE-NAME为软件名，VERSION为软件的版本号，BUG-REPORT-ADDRESS为bug的报告地址，一般为软件作者的邮箱)
• AC_CONFIG_SRCDIR用来侦测指定的源码文件是否存在，确定源码目录的有效性。此处为当前目录下hello.c
• AC_CONFIG_HEADER用于生成config.h文件，以便autoheader使用
• AC_PROG_CC用来指定编译器，以便不指定的时候默认为gcc
• AC_OUTPUT用来设定config要产生的文件。如果是Makefile,config会把它检查出来的结果带入Makefile.in文件产生合适的Makefile.

4. 获得并且修改configure.ac(或configure.in)

cp configure.scan configure.ac
vim configure.ac

view code

#                                               -*- Autoconf -*-
# Process this file with autoconf to produce a configure script.

AC_PREREQ([2.69])
AC_INIT(hello, 1.0, 547238541@qq.com)
AM_INIT_AUTOMAKE(hello,1.0)
AC_CONFIG_SRCDIR([hello.c])
AC_CONFIG_HEADERS([config.h])

# Checks for programs.
AC_PROG_CC

# Checks for libraries.

# Checks for header files.

# Checks for typedefs, structures, and compiler characteristics.

# Checks for library functions.

AC_OUTPUT(Makefile)

5.使用aclocal工具生成aclocal.m4

ubuntu@ubuntu-MS-7C88:~/SambaFolder/automake_demo$ aclocal

6.使用autoconf工具生成configure文件

ubuntu@ubuntu-MS-7C88:~/SambaFolder/automake_demo$ autoconf

7.使用autoheader工具生成config.h.in文件

ubuntu@ubuntu-MS-7C88:~/SambaFolder/automake_demo$ autoheader

8. 手动添加必要的文件 NEWS，README，AUTHORS，ChangeLog

touch NEWS README ChangeLog AUTHORS

9.创建Makefile.am文件

Automake工具会根据config.in中的参量把Makefile.am转换成Makefile.in文件。在使用Automake之前，要先手动建立Makefile.am文件。

AUTOMAKE_OPTIONS=foreign
bin_PROGRAMS=hello
hello_SOURCES=hello.c

• AUTOMAKE_OPTIONS为设置的Automake选项。它有三种等级提供给用户选择：foreign，gnu,gnits,默认等级为gnu.在此使用foreign，它只检测必须的文件。
• bin_PROGRAMS定义要产生的执行文件名。如果要产生多个可执行文件，则每个文件名用空格隔开。
• hello_SOURCES定义为hello这个程序所需要的原始文件。如果其中由多个文件组成的，则必须用空格进行隔开。
• 多个源文件处理方式如下

  AUTOMAKE_OPTIONS=foreign
  bin_PROGRAMS=test
  test_SOURCES=max.h max.c min.h min.c test.c
  

10.使用Automake生成Makefile.in文件

要使用选项“--add-missing”可以让Automake自动添加一些必要的脚本文件。
ubuntu@ubuntu-MS-7C88:~/SambaFolder/automake_demo$ automake --add-missing

11.配置 & Cross Compile Configure

• 本地运行自动配置设置文件configure，把Makefile.in编程最终的Makefile.
  ubuntu@ubuntu-MS-7C88:~/SambaFolder/automake_demo$ ./configure
  

• 交叉编译自动配置设置文件configure，把Makefile.in编程最终的Makefile.
  ubuntu@ubuntu-MS-7C88:~/SambaFolder/automake_demo$ ./configure --prefix=/home/ubuntu/SambaFolder/temp --host=aarch64-linux-gnu
  

12.测试make

ubuntu@ubuntu-MS-7C88:~/SambaFolder/automake_demo$ make

13.运行hello

ubuntu@ubuntu-MS-7C88:~/SambaFolder/automake_demo$ ./hello

流程图

总结

针对上面提到的各个命令，我们再做些详细的介绍。

1、autoscan

autoscan是用来扫描源代码目录生成configure.scan文件的。autoscan可以用目录名做为参数，但如果你不使用参数的话，那么autoscan将认为使用的是当前目录。autoscan将扫描你所指定目录中的源文件，并创建configure.scan文件。

2、configure.scan

configure.scan包含了系统配置的基本选项，里面都是一些宏定义。我们需要将它改名为configure.in

3、aclocal

aclocal是一个perl 脚本程序。aclocal根据configure.in文件的内容，自动生成aclocal.m4文件。
aclocal的定义是：“aclocal - create aclocal.m4 by scanning configure.ac”
m4是 一个宏处理器.将输入拷贝到输出,同时将宏展开.宏可以是内嵌的,也可以是用户定义的.
除了可以展开宏,m4还有一些内建的函数,用来引用文件,执行命令,整数运算,文本操作,循环等.m4既可以作为编译器的前端,也可以单独作为一个宏处理器.

4、autoconf

     autoconf是用来产生configure文件的。configure是一个脚本，它能设置源程序来适应各种不同的操作系统平台，并且根据不同的系统来产生合适的Makefile，从而可以使你的源代码能在不同的操作系统平台上被编译出来。

　　在configure.ini中：

　　#号表示注释，这个宏后面的内容将被忽略。

• AC_INIT(FILE)

  这个宏用来检查源代码所在的路径

• AM_INIT_AUTOMAKE(PACKAGE, VERSION)

  这个宏是必须的，它描述了我们将要生成的软件包的名字及其版本号：PACKAGE是软件包的名字，VERSION是版本号。
  当你使用make dist命令时，它会给你生成一个类似helloworld-1.0.tar.gz的软件发行包，其中就有对应的软件包的名字和版本号。

• AC_PROG_CC

  这个宏将检查系统所用的C编译器。

• AC_OUTPUT(FILE)

  这个宏是我们要输出的Makefile的名字，我们在使用automake时，实际上还需要用到其他的一些宏，但我们可以用aclocal 来帮我们自动产生。
  执行aclocal后我们会得到aclocal.m4文件。
  产生了configure.in和aclocal.m4 两个宏文件后，我们就可以使用autoconf来产生configure文件了。

5、Makefile.am

Makefile.am是用来生成Makefile.in的，需要你手工书写。Makefile.am中定义了一些内容：

• AUTOMAKE_OPTIONS

  这个是automake的选项。在执行automake时，它会检查目录下是否存在标准GNU软件包中应具备的各种文件，例如AUTHORS、ChangeLog、NEWS等文件。我们将其设置成foreign时，automake会改用一般软件包的标准来检查

• bin_PROGRAMS

  这个是指定我们所要产生的可执行文件的文件名。如果你要产生多个可执行文件，那么在各个名字间用空格隔开。

• helloworld_SOURCES

  这个是指定产生“helloworld”时所需要的源代码。如果它用到了多个源文件，那么请使用空格符号将它们隔开。
  比如需要helloworld.h，helloworld.c那么请写成 helloworld_SOURCES= helloworld.h helloworld.c
  如果你在bin_PROGRAMS定义了多个可执行文件，则对应每个可执行文件都要定义相对的filename_SOURCES。

6、 automake

我们使用automake --add-missing来产生Makefile.in。
选项--add-missing的定义是“add missing standard files to package”，它会让automake加入一个标准的软件包所必须的一些文件。
我们用automake产生出来的Makefile.in文件是符合GNU Makefile惯例的，接下来我们只要执行configure这个shell 脚本就可以产生合适的 Makefile 文件了。

7、 Makefile

在符合GNU Makefiel惯例的Makefile中，包含了一些基本的预先定义的操作：

• make

  根据Makefile编译源代码，连接，生成目标文件，可执行文件。

• make clean

  清除上次的make命令所产生的object文件（后缀为“.o”的文件）及可执行文件。

• make install

  将编译成功的可执行文件安装到系统目录中，一般为/usr/local/bin目录。

• make dist

  产生发布软件包文件（即distribution package）。这个命令将会将可执行文件及相关文件打包成一个tar.gz压缩的文件用来作为发布软件的软件包。
  它会在当前目录下生成一个名字类似“PACKAGE-VERSION.tar.gz”的文件。
  PACKAGE和VERSION，是我们在configure.in中定义的AM_INIT_AUTOMAKE(PACKAGE, VERSION)。

• make distcheck

  生成发布软件包并对其进行测试检查，以确定发布包的正确性。
  这个操作将自动把压缩包文件解开，然后执行configure命令，并且执行make，来确认编译不出现错误，最后提示你软件包已经准备好，可以发布了。

• make distclean
  类似make clean，但同时也将configure生成的文件全部删除掉，包括Makefile。

  view code

  
  test -z "hello" || rm -f hello
  rm -f *.o
  rm -f *.tab.c
  test -z "" || rm -f 
  test . = "." || test -z "" || rm -f 
  rm -f config.h stamp-h1
  rm -f TAGS ID GTAGS GRTAGS GSYMS GPATH tags
  rm -f cscope.out cscope.in.out cscope.po.out cscope.files
  rm -f config.status config.cache config.log configure.lineno config.status.lineno
  rm -rf ./.deps
  rm -f Makefile
  

  
  

Notice

如果运行automake --add-missing后出现如下提示

Makefile.am: error: required file './NEWS' not found
Makefile.am: error: required file './README' not found
Makefile.am: error: required file './AUTHORS' not found
Makefile.am: error: required file './ChangeLog' not found

则运行即可
touch NEWS README ChangeLog AUTHORS

Reference

Automake官网
Automake使用说明
Automake-Autoconf使用详解

附录

configure.ac宏定义说明

宏	作用	示例
AC_PREREQ	autoconf最低版本	AC_PREREQ([2.69])
AC_INIT	初始化包信息，将会自动生成PACKAGE_NAME、PACKAGE_VERSION、PACKAGE_BUGREPORT宏	AC_INIT([Porject], [1.0], [fwdssg.love@163.com])
AC_CONFIG_SRCDIR	通过检测目录中必定存在的文件来判断目录是否存在	AC_CONFIG_SRCDIR([src/main.cpp])
AC_CONFIG_HEADERS	生成config.h文件保存configure.ac定义的宏，此文件可被源文件包含	AC_CONFIG_HEADERS([config.h])
AC_CONFIG_MACRO_DIRS	指定本地宏文件的存放目录，.m4后缀的文件都将被保存进此目录,acloacl命令会自动创建此目录	AC_CONFIG_MACRO_DIRS([m4])
AC_CONFIG_AUX_DIR	指定辅助脚本文件的存放目录	AC_CONFIG_AUX_DIR([build-aux])
AC_MSG_CHECKING	打印"checking XXX ..."	AC_MSG_CHECKING([for native Win32])
AC_MSG_RESULT	打印checking结果并另起新行	AC_MSG_RESULT([$os_win32])
AC_PROG_INSTALL	生成安装脚本 install-sh	AC_PROG_INSTALL
AC_PROG_LIBTOOL	使得configure能够支持--enable-shared、--disable-shared、--enable-static、--disable-static、--with-pic和--without-pic参数	AC_PROG_LIBTOOL
AC_PROG_CXX	自动检测要使用的C++编译器	AC_PROG_CXX
AC_PROG_CC	自动检测要使用的C编译器	AC_PROG_CC
AC_CHECK_HEADERS	检测系统头文件是否存在	AC_CHECK_HEADERS([sys/socket.h netinet/in.h arpa/inet.h])
AC_SUBST	输出能够被Makefile.am使用的变量	AC_SUBST(GLIB2_CFLAGS)
AC_CONFIG_SUBDIRS	configure子目录	AC_CONFIG_SUBDIRS([spice-common])
PKG_CHECK_MODULES	检测对应模块是否存在	PKG_CHECK_MODULES([SPICE_PROTOCOL], [spice-protocol >= 0.12.11])
AC_CHECK_FUNCS	检测对应函数是否可用	AC_CHECK_FUNCS([setlocale])
AC_ARG_ENABLE	为configure添加--XX选项	AC_ARG_ENABLE([gstaudio],AS_HELP_STRING([--enable-gstaudio=@<:@yes/auto/no@:>@], [Enable the GStreamer 1.0 audio backend @<:@default=auto@:>@]),[],[enable_gstaudio="auto"])
AC_OUTPUT	运行configure后生成的config脚本需要处理的文件，将Makefile.in变成Makefile	AC_OUTPUT([Makefile])
AM_INIT_AUTOMAKE	初始化automake	AM_INIT_AUTOMAKE([subdir-objects -Wno-portability])
AM_GNU_GETTEXT	初始化gettext	AM_GNU_GETTEXT([external])
AM_GNU_GETTEXT_VERSION	指定gettext最低版本	AM_GNU_GETTEXT_VERSION([0.19.7])
IT_PROG_INTLTOOL	初始化并指定libtool最低版本	IT_PROG_INTLTOOL([0.35.0])
AM_CONDITIONAL	根据条件来定义宏	AM_CONDITIONAL([OS_WIN32],[test "(os_win32" = "yes"]) #如果)os_win32的值为yes则#define OS_WIN32宏

Makefile.am宏定义说明

宏	作用	示例
ACLOCAL_AMFLAGS	指定宏文件的存放目录，与AC_CONFIG_MACRO_DIRS成配合使用	ACLOCAL_AMFLAGS = -I m4
SUBDIRS	指定需要递归automake的子文件夹，即存在Makefile.am的子文件夹	SUBDIRS = spice-common src man po doc data
EXTRA_DIST	指定要被打包的额外文件，即执行make dist时需要被放入压缩包的文件，一般是不需要参与编译但是又需要被使用的文件，比如图片目录里的图片	EXTRA_DIST = $(PACKAGE).spec
DISTCLEAN_FILES	执行make distclean时候需要删除的文件，一般是EXTRA_DIST中的.in文件生成的不需要打包的中间文件	DISTCLEAN_FILES = $(PACKAGE).spec
MAINTAINERCLEANFILES	执行make maintainer-clean时候需要删除的文件，即执行autoreconf -vfi、intltoolize --force以及configure或执行autogen.sh后能够重新生成的文件都要放入其中	MAINTAINERCLEANFILES = $(srcdir)/AUTHORS
dist-hook	执行make dist时需要执行的脚本	dist-hook: gen-ChangeLog gen-AUTHORS
bin_PROGRAMS	要生成的可执行文件	bin_PROGRAMS = spicy
XX_SOURCES	编译可执行文件所需的源文件	spicy_SOURCES = spicy.c
XX_LIBADD	链接参数，即pkg-config --libs的结果	spicy_stats_LDADD = libspice-client-glib-2.0.la
XX_CFLAGS	编译参数，即pkg-config --cflags的结果和-D之类的宏定义	libvirt_viewer_la_CFLAGS = -DLOCALE_DIR=""./../share/locale"" $(GLIB2_CFLAGS)
nodist_XX_SOURCES	执行make dist时不需要被打包的源文件，一般是根据其他源文件通过脚本临时生成的中间源文件,比如使用glib-genmarshal生成的文件	nodist_libspice_client_glib_2_0_la_SOURCES = spice-marshal.c spice-marshal.h
LDADD	无法被configure找到但是又需要链接的库或资源文件，例如临时生成的windows下使用的rc文件	LDADD += virt-viewer_rc.$(OBJEXT)
dist_XX_DATA	程序运行需要的数据文件，比如图标、配置文件等	dist_cfg_DATA = xx.cfg
dist_bin_SCRIPTS	程序的脚本文件，将被安装到bin目录	dist_bin_SCRIPTS = xx.sh