相关概念的介绍

什么是Makefile?怎么书写Makefile?竟然有工具可以自动生成Makefile?怎么生成啊?开始的时候,我有这么多疑问,所以,必须得先把基本的概念搞个清楚。

  • Makefile
    makefile用来定义整个工程的编译规则。一个工程中的源文件计数,其按类型、功能、模块分别放在若干个目录中,makefile定义了一系列的规则来指定,哪些文件需要先编译,哪些文件需要后编译,哪些文件需要重新编译,甚至于进行更复杂的功能操作,因为 makefile就像一个Shell脚本一样,其中也可以执行操作系统的命令。

      makefile带来的好处就是——“自动化编译”,一旦写好,只需要一个make命令,整个工程完全自动编译,极大的提高了软件开发的效率。make是一个命令工具,是一个解释makefile中指令的命令工具,一般来说,大多数的IDE都有这个命令,比如:Delphi的make,Visual C++的nmake,Linux下GNU的make。可见,makefile都成为了一种在工程方面的编译方法。

  • Autoconf
    Autoconf是一个用于生成可以自动地配置软件源代码包以适应多种Unix类系统的 shell脚本的工具。由Autoconf生成的配置脚本在运行的时候与Autoconf是无关的, 就是说配置脚本的用户并不需要拥有Autoconf。

           对于每个使用了Autoconf的软件包,Autoconf从一个列举了该软件包需要的,或者可以使用的系统特征的列表的模板文件中生成配置脚本。在shell代码识别并响应了一个被列出的系统特征之后,Autoconf允许多个可能使用(或者需要)该特征的软件包共享该特征。 如果后来因为某些原因需要调整shell代码,就只要在一个地方进行修改; 所有的配置脚本都将被自动地重新生成以使用更新了的代码。

  • Automake
    Automake是一个从文件`Makefile.am’自动生成`Makefile.in’ 的工具。每个`Makefile.am’基本上是一系列make的宏定义 (make规则也会偶尔出现)。生成的`Makefile.in’服从GNU Makefile标准。GNU Makefile标准文档长、复杂,而且会发生改变。Automake的目的就是解除个人GNU维护者维护Makefile的负担 (并且让Automake的维护者来承担这个负担)。典型的Automake输入文件是一系列简单的宏定义。处理所有这样的文件以创建
    `Makefile.in’。在一个项目(project)的每个目录中通常包含一个 `Makefile.am’。Automake在几个方面对一个项目做了限制;例如它假定项目使用Autoconf并且对`configure.in’的内容施加了某些限制。

           Automake支持三种目录层次: “flat”、“shallow”和“deep”。一个flat(平)包指的是所有文件都在一个目录中的包。为这类包提供的`Makefile.am’ 缺少宏SUBDIRS。这类包的一个例子是termutils。一个deep(深)包指的是所有的源代码都被储存在子目录中的包;顶层 目录主要包含配置信息。GNU cpio 是这类包的一个很好的例子,GNU tar也是。deep包的顶层`Makefile.am’将包括 宏SUBDIRS,但没有其它定义需要创建的对象的宏。一个shallow(浅)包指的是主要的源代码储存在顶层目录中,而
    各个部分(典型的是库)则储存在子目录中的包。Automake本身就是这类包(GNU make也是如此,它现在已经不使用automake)。

Automake – Flat 实例

顶级目录hello_world,该目录下存在三个文件。mytest.h头文件声明了sayhello()方法;mytest.c中实现了sayhello()方法;mymain.c中的main调用了sayhello()方法。

root@ubuntu:~/c_demo/automake/app# tree
.
└── hello_world
    ├── configure.ac
    ├── Makefile.am
    ├── mymain.c
    ├── mytest.c
    └── mytest.h

1 directory, 5 files
  • 执行步骤
    • 1. Autoscan
      在hello_world目录下执行autoscan命令,其中生成一个configure.scan的文件
    • 2. 将configure.scan文件更名为configure.ac文件
    • 3. 打开configure.ac文件,修改文件内容
      #                                               -*- Autoconf -*-
      # Process this file with autoconf to produce a configure script.
      
      #AC_PREREQ([2.69])
      AC_INIT([hello], [1.0], [sunlrain02@gmail.com])
      AC_CONFIG_SRCDIR([mymain.c])
      #AC_CONFIG_HEADERS([config.h])
      
      AM_INIT_AUTOMAKE(hello, 1.0)
      
      # 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)
      
    • 4. 然后分别执行以下两个命令
      aclocal
      autoconf
      
    • 5. 在hello_world文件夹下创建一个名为Makefile.am的文件,并输入以下内容:
      AUTOMAKE_OPTIONS=foreign
      bin_PROGRAMS=hello
      hello_SOURCES=mymain.c mytest.c mytest.h
      
    • 6. 执行命令“automake –add-missing”,automake 会根据Makefile.am 文件产生一些文件,其中包含最重要的Makefile.in
    • 7. 执行“./configure”命令生成Makefile文件
    • 8. 执行“make”命令来编译mymain.c程序,从而生成可执行程序hello。生成可执行程序hello后,执行“./hello”

Automake – Shallow 实例

目录结构 – 顶级目录hello_world,该目录下存在一个主文件mymain.c和一个目录head。head目录中,mytest.h头文件声明了sayhello()方法;mytest.c中实现了sayhello()方法;mymain.c中的main调用了sayhello()方法。

root@ubuntu:~/c_demo/automake/liba_shallow# tree
.
└── hello_world
    ├── configure.ac
    ├── head
    │   ├── Makefile.am
    │   ├── mytest.c
    │   └── mytest.h
    ├── Makefile.am
    └── mymain.c

2 directories, 6 files
  • 执行步骤
    • 1. 在顶层目录下运行autoscan产生configure.scan文件
    • 2. 将configure.scan文件更名为configure.ac文件
    • 3.打开configure.ac文件,修改文件内容
      #                                               -*- Autoconf -*-
      # Process this file with autoconf to produce a configure script.
      
      #AC_PREREQ([2.69])
      AC_INIT([hello], [1.0], [sunlrain02@gmail.com])
      AC_CONFIG_SRCDIR([mymain.c])
      #AC_CONFIG_HEADERS([config.h])
      
      AM_INIT_AUTOMAKE(hello, 1.0)
      
      # Checks for programs.
      AC_PROG_CC
      
      AC_PROG_RANLIB
      
      # Checks for libraries.
      
      # Checks for header files.
      
      # Checks for typedefs, structures, and compiler characteristics.
      
      # Checks for library functions.
      
      AC_OUTPUT(Makefile head/Makefile)
      
    • 4. 然后分别执行以下两个命令
      aclocal
      autoconf
      
    • 5.在head文件夹下创建Makefile.am文件,内容如下:
      AUTOMAKE_OPTIONS=foreign
      noinst_LIBRARIES=libmytest.a
      libmytest_a_SOURCES=mytest.c mytest.h
      
    • 6.在hello_world文件夹下创建Makefile.am文件,内容如下:
      AUTOMAKE_OPTIONS=foreign
      SUBDIRS=head
      
      INCLUDES=-I./head
      
      bin_PROGRAMS=hello
      hello_SOURCES=mymain.c
      hello_LDADD=head/libmytest.a
      
    • 7. 执行命令“automake –add-missing”,automake会根据Makefile.am 文件产生一些文件,其中包含最重要的Makefile.in
    • 8. 执行“./configure”命令生成Makefile文件
    • 9. 执行“make”命令来编译mymain.c程序,从而生成可执行程序hello。生成可执行程序hello后,执行“./hello”

Automake – Deep 实例

目录结构 – 顶级目录hello——world,该目录下存在三个目录src, head, include。include 目录中,mytest.h头文件声明了sayhello()方法; Head目录中,mytest.c中实现了sayhello()方法;src目 录中的mymain.c中的main调用了sayhello()方法。

root@ubuntu:~/c_demo/automake/liba_deep# tree
.
└── hello_world
    ├── configure.ac
    ├── head
    │   ├── Makefile.am
    │   └── mytest.c
    ├── include
    │   └── mytest.h
    ├── Makefile.am
    └── src
        ├── Makefile.am
        └── mymain.c

4 directories, 7 files
  • 执行步骤
    • 1. 在顶层目录下运行autoscan产生configure.scan文件
    • 2. 将configure.scan文件更名为configure.ac文件
    • 3.打开configure.ac文件,修改文件内容
      #                                               -*- Autoconf -*-
      # Process this file with autoconf to produce a configure script.
      
      #AC_PREREQ([2.69])
      AC_INIT([hello], [1.0], [sunlrain02@gmail.com])
      AC_CONFIG_SRCDIR([src/mymain.c])
      #AC_CONFIG_HEADERS([config.h])
      
      AM_INIT_AUTOMAKE(hello, 1.0)
      
      # Checks for programs.
      AC_PROG_CC
      
      AC_PROG_RANLIB
      
      # Checks for libraries.
      
      # Checks for header files.
      
      # Checks for typedefs, structures, and compiler characteristics.
      
      # Checks for library functions.
      
      AC_OUTPUT(Makefile src/Makefile head/Makefile)
      
    • 4. 然后分别执行以下两个命令
      aclocal
      autoconf
      
    • 5.在head文件夹下创建Makefile.am文件,内容如下:
      AUTOMAKE_OPTIONS=foreign
      
      INCLUDES=-I../include
      
      noinst_LIBRARIES=libmytest.a
      libmytest_a_SOURCES=mytest.c mytest.h
      
    • 6. 在src文件夹下创建Makefile.am文件, 内容如下:
      AUTOMAKE_OPTIONS=foreign
      
      INCLUDES=-I../include
      
      bin_PROGRAMS=hello
      hello_SOURCES=mymain.c
      hello_LDADD=../head/libmytest.a
      
    • 7.在hello_world文件夹下创建Makefile.am文件,内容如下:
      AUTOMAKE_OPTIONS=foreign
      SUBDIRS=head src
      
    • 8. 执行命令“automake –add-missing”,automake会根据Makefile.am 文件产生一些文件,其中包含最重要的Makefile.in
    • 9. 执行“./configure”命令生成Makefile文件
    • 10. 执行“make”命令来编译mymain.c程序,从而生成可执行程序hello。生成可执行程序hello后,执行“./hello”
  • 总结

    归纳一下以上所有例子的流程:

    • 在存放源代码的顶层目录下执行autoscan命令生成configure.scan文件。
    • 将configure.scan文件改名为configure.in,并对其默认配置进行修改。
    • 执行aclocal、autoconf两个命令,分别生成aclocal.m4、configure文件。
    • 在每个目录下创建一个名为Makefile.am的文件,并输入相应的内容。
    • 执行automake –add-missing,它根据Makefile.am文件,生成Makefile.in。
    • 执行./configure脚本文件,它根据Makefile.in文件,生成最终的Makefile文件。
    • 生成Makefile之后,执行“make”编译工程并且生成可执行程序。

    能力进阶

    以上的的程序还只是处于初级阶段,并且生成的是 静态库 。我们可以发现,用autoconf和automake生成Makefile的关键在于configure.in和Makefile.am的文件的书写。所以,要想使自己的功力更上一层,需要熟悉autoconf和automake这两个工具的使用,其中有很多重要的宏需要我们了解。这里时具体的参考手册:

    autoconf手册

           英文版:http://www.gnu.org/software/autoconf/manual/autoconf.html

           中文版:http://www.linuxforum.net/books/autoconf.html

    automake手册

           中文版:http://www.linuxforum.net/books/automake.html

    如何使用产生的Makefile文件

    执行configure脚本文件所产生的Makefile文件有几个预定的选项可供使用:

    make all:产生设定的目标,即生成所有的可执行文件。使用make也可以达到此目的。

    make clean:删除之前编译时生成的可执行文件及目标文件(形如*.o的中间文件)。

    make distclean:除了删除可执行文件和目标文件以外,把configure所产生的 Makefile文件也清除掉。通常在发布软件前执行该命令。

    make install:将使用make all或make命令产生的可执行文件以软件的形式安装到系统中。若使用bin_PROGRAMS宏,程序将会被安装到 /usr/local/bin下,否则安装到预定义的目录下。

    make dist:将程序和相关的文档包装为一个压缩文档以供发布。执行完该命令,在当前目录下会产生一个名为PACKAGE-VERSION.tar.gz的文件。PACKAGE 和 VERSION 这两个参数是来自configure.in文件中的AM_INIT_AUTOMAKE(PACKAGE,

    VERSION)。如在上个例子中执行make dist命令,会产生名为“hello-1.0.tar.gz”的文件。

    make distcheck:与make dist类似,但是加入了检查包装以后的压缩文件是否正常。

    更多 文章参见

    Configure.in文件解析
    Makefile.am 文件解析
    Automake 动态库编译

    分类: Makefile

    发表评论

    电子邮件地址不会被公开。 必填项已用*标注