automake生成makefile学习

sudo apt-get install automake

autoconf是一个用于生成可以自动地配置软件源码包,用以适应多种UNIX类系统的shell脚本工具,其中autoconf需要用到 m4,便于生成脚本。automake是一个从Makefile.am文件自动生成Makefile.in的工具。为了生成Makefile.in,automake还需用到perl,由于automake创建的发布完全遵循GNU标准,所以在创建中不需要perl。libtool是一款方便生成各种程序库的工具。

目前automake支持三种目录层次:flat、shallow和deep。

1) flat指的是所有文件都位于同一个目录中。

就是所有源文件、头文件以及其他库文件都位于当前目录中,且没有子目录。Termutils就是这一类。

2) shallow指的是主要的源代码都储存在顶层目录,其他各个部分则储存在子目录中。

就是主要源文件在当前目录中,而其它一些实现各部分功能的源文件位于各自不同的目录。automake本身就是这一类。

3) deep指的是所有源代码都被储存在子目录中;顶层目录主要包含配置信息。

就是所有源文件及自己写的头文件位于当前目录的一个子目录中,而当前目录里没有任何源文件。 GNU cpio和GNU tar就是这一类。

flat类型是最简单的,deep类型是最复杂的。


生成 Makefile 的来龙去脉

首先进入 project 目录,在该目录下运行一系列命令,创建和修改几个文件,就可以生成符合该平台的Makefile文件,操作过程如下:

1) 运行autoscan命令

2) 将configure.scan 文件重命名为configure.in,并修改configure.in文件

3) 在project目录下新建Makefile.am文件,并在core和shell目录下也新建makefile.am文件

4) 在project目录下新建NEWS、 README、 ChangeLog 、AUTHORS文件

5) 将/usr/share/automake-1.X/目录下的depcomp和complie文件拷贝到本目录下

6) 运行aclocal命令

7) 运行autoconf命令

8) 运行automake -a命令

9) 运行./confiugre脚本


automake生成makefile学习_第1张图片


automake生成makefile学习_第2张图片



autoheader主要用来生成 config.h.in 宏定义

首先简略的说一下用automake生成Makefile的步骤:

(1)创建源代码文件,使用”autoscan”生成configure.scan文件,将其重命名为configure.ac,并做适当修改,

          然后使用”aclocal”命令生成aclocal.m4文件,使用”autoconf”命令由configure.ac和aclocal.m4文件生成configure文件。
(2)手工编辑Makefile.am文件,使用”automake”命令生成configure.in文件。
(3)手工编辑或由系统给定acconfig.h文件,使用”autoheader”命令生成config.h.in文件。
(4)使用”configure”命令由configure、configure.in和config.h.in文件生成Makefile文件。从而完成Makefile文件的创建过程。


automake实例:

helloworld.c 

[cpp] view plain copy
  1. #include   
  2. #include   
  3. extern int output(char* data);  
  4. int main()  
  5. {  
  6.     int n=15;  
  7.     printf("hellow world %d \n",n);  
  8.     output("from helloword.c");  
  9.     return 0;  
  10. }  

output.c

[cpp] view plain copy
  1. #include   
  2. #include   
  3. int output(char* data)  
  4. {  
  5.     printf("output data=%s\n",data);  
  6.     return 0;  
  7. }  

1、执行命令:

autoscan

Autoscan工具用来扫描源代码以搜寻一般的可移植性问题,比如检查编译器、库和头文件等,
并创建configure.scan文件,它会在给定目录及其子目录树中检查源文件,若没有给出目录,
就在当前目录及其子目录树中进行检查。

2、修改configure.scan并改名为configure.ac

# -*- Autoconf -*-

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

AC_PREREQ([2.68])

AC_INIT([helloworld], [2.0], [[email protected]])

AM_INIT_AUTOMAKE(helloworld,2.0) 

AC_CONFIG_SRCDIR([output.c])

AC_CONFIG_HEADERS([config.h])

# Checks for programs.

AC_PROG_CC

# Checks for libraries.

# Checks for header files.

AC_CHECK_HEADERS([string.h])

# Checks for typedefs, structures, and compiler characteristics.

# Checks for library functions.

AC_OUTPUT(Makefile)

命令:mv configure.scan configure.ac

   gedit  configure.ac

下面给出本文件的简要说明(所有以”#”号开始的行为注释):

(1)AC_PREREQ宏声明本文件要求的autoconf版本,本例使用的版本为2.59。

(2)AC_INIT宏用来定义软件的名称和版本等信息,”FULL-PACKAGE-NAME”为软件包名称,”VERSION”为软件版本号,”BUG-REPORT-ADDRESS”为BUG报告地址(一般为软件作者邮件地址)。

(3)AC_CONFIG_SRCDIR宏用来侦测所指定的源码文件是否存在,来确定源码目录的有效性。此处为当前目录下的hello.c。

(4)AC_CONFIG_HEADER宏用于生成config.h文件,以便autoheader使用。

(5)AC_PROG_CC用来指定编译器,如果不指定,选用默认gcc。

(6)AC_OUTPUT用来设定 configure 所要产生的文件,如果是makefile,configure会把它检查出来的结果带入makefile.in文件产生合适的makefile。使用Automake时,还需要一些其他的参数,这些额外的宏用aclocal工具产生。

此文件只是下面要使用的configure.ac文件的原型

3、执行命令:

  aclocal  产生aclocal.m4文件、即为配置成功

aclocal根据configure.ac生成aclocal.m4


  autoconf 产生configure文件、即为配置成功

将configure.ac中的宏展开,生成configure脚本。这个过程可能要用到aclocal.m4中定义的宏。


4、执行命令:

  autoheader   生成config.h.in


5、创建和编辑Makefile.am文件:

 gedit Makefile.am

内容为:

AUTOMAKE_OPTIONS= foreign 

bin_PROGRAMS= helloworld 

helloworld_SOURCES= helloworld.c output.c

Automake工具会根据configure.in中的参量把Makefile.am转换成Makefile.in文件。所以在使用automake之前我们需要自己创建Makefile.am文件。

其中:

(1)AUTOMAKE_OPTIONS为设置Automake的选项。由于GNU对自己发布的软件有严格的规范,比如必须附带许可证声明文件COPYING等,否则Automake执行时会报错。Automake提供了3种软件等级:foreign、gnu和gnits,供用户选择,默认等级为gnu。本例使需用foreign等级,它只检测必须的文件。

(2)bin_PROGRAMS定义要产生的执行文件名。如果要产生多个执行文件,每个文件名用空格隔开。

(3)hello_SOURCES定义”hello”这个执行程序所需要的原始文件。如果”hello”这个程序是由多个原始文件所产生的,则必须把它所用到的所有原始文件都列出来,并用空格隔开。例如:若目标体”hello”需要”hello.c”、”hello.h”两个依赖文件,则定义hello_SOURCES=hello.c hello.h。


6、automake --add-missing 生成Makefile.in文件,无输出信息即可成功

7、./configure

8、Make

9、Make install 编译完成

10、运行:

./helloworld

11、打包发布,生成helloworld-2.0.tar.gz

 make dist


下面是另一种文档结构

|-- conf
|   `-- test.conf
`-- src
    |-- test1.c
    |-- test2.c
    `-- test2.h

src为源文件目录,conf为配置文件的目录。创建Makefile的方式和上面有一点点不同

1.执行autoscan命令

root@ubuntu:~/test# autoscan
root@ubuntu:~/test# ls
autoscan.log  conf  configure.scan  src
root@ubuntu:~/test# cat configure.scan
#                                               -*- Autoconf -*-
# Process this file with autoconf to produce a configure script.

AC_PREREQ([2.65])
AC_INIT([FULL-PACKAGE-NAME], [VERSION], [BUG-REPORT-ADDRESS])
AC_CONFIG_SRCDIR([src/test2.h])
AC_CONFIG_HEADERS([config.h])

# Checks for programs.
AC_PROG_CC

# Checks for libraries.

# Checks for header files.
AC_CHECK_HEADERS([stdlib.h string.h])

# Checks for typedefs, structures, and compiler characteristics.

# Checks for library functions.

AC_OUTPUT

修改configure.scan为configure.ac

root@ubuntu:~/test# mv configure.scan configure.ac
root@ubuntu:~/test# vim configure.ac
root@ubuntu:~/test# cat configure.ac
#                                               -*- Autoconf -*-
# Process this file with autoconf to produce a configure script.

AC_PREREQ([2.65])
AC_INIT(test, 1.0)
AM_INIT_AUTOMAKE(test, 1.0)
AC_CONFIG_SRCDIR([src/test2.h])

# Checks for programs.
AC_PROG_CC

# Checks for libraries.
AC_CHECK_LIB(pthread, pthread_create)  //pthread为链接库名字, 
//pthread_create为库中的一个函数

# Checks for header files.
AC_CHECK_HEADERS(stdlib.h string.h pthread.h) 

# Checks for typedefs, structures, and compiler characteristics.

# Checks for library functions.

AC_OUTPUT(Makefile
		    src/Makefile
		    conf/Makefile)             //每一个目录需要输出一个Makefile
//文件

2.使用aclocal工具生成aclocal.m4
3.使用autoconf工具生成configure文件
4. 创建Makefile.am

在顶层目录创建的Makefile.am的内容如下

root@ubuntu:~/test# vi Makefile.am
root@ubuntu:~/test# cat Makefile.am
SUBDIRS= src conf

在src目录下创建的Makefile.am内容如下

root@ubuntu:~/test# cd src/
root@ubuntu:~/test/src# vi Makefile.am
root@ubuntu:~/test/src# cat Makefile.am
bin_PROGRAMS= test
test_SOURCES= test1.c test2.c

在conf目录下创建的Makefile.am内容如下

root@ubuntu:~/test/conf# vi Makefile.am
root@ubuntu:~/test/conf# cat Makefile.am
configdir = /etc             //这个数据文件将要移动到的目录
config_DATA = test.conf    //数据文件名,如果有多个文件则这样写config_DATA = 
test1.dat test2.dat

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

root@ubuntu:~/test# automake --add-missing
Makefile.am: required file `./NEWS' not found
Makefile.am: required file `./README' not found
Makefile.am: required file `./AUTHORS' not found
Makefile.am: required file `./ChangeLog' not found

这里出现了一个问题,NEWS, README这几个文件不存在, 那么我们就手工创建他们

root@ubuntu:~/test# touch NEWS README AUTHORS ChangeLog

再次执行automake

root@ubuntu:~/test# automake

6.后面的步骤就和上面的例子一样了



-------------------------------------------我是分割线------------------------------

注意:

1.文件的生成顺序,即文件是有依赖关系的,如果生成的顺序不对,某些文件的内容是不对的,即可能执行错误!

2.执行aclocal命令后只生成autom4te.cache没有生成aclocal.m4文件

因为你在configure.in文件中没有添加 AM_INIT_AUTOMAKE(PACKAGE, VERSION) 和AC_CONFIG_FILES([Makefile]) 这两个宏。

3.

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。




你可能感兴趣的:(linux/unix,C/C++)