轻轻松松制作Makefile

magic

许明彦 <myhsu@cyberdude.com>
February 11, 1999
Abstract:
在 Unix 上写程序的人大概都碰过 Makefile，尤其是用 C 来开发程序的人。用 make 来开发和编译程序的确很方便，可是要写出一个 Makefile 就不简单了。偏偏介绍 Makefile 的檔不多，GNU Make 那份印出来要几百页的檔，光看完 Overview 就快阵亡了，难怪许多人闻 Unix 色变。本文将介绍如何利用 GNU Autoconf 及 Automake 这两套软件来协助我们‘自动’产生 Makefile 檔，并且让开发出来的软件可以像 Apache, MySQL 和常见的 GNU 软件一样，只要会 ``./configure'', ``make'', ``make install'' 就可以把程序安装到系统中。如果您有心开发 Open Source 的软件，或只是想在 Unix 系统下写写程序。希望这份介绍檔能帮助您轻松地进入 Unix Programming 的殿堂。

1. 简介
Makefile 基本上就是‘目标’(target), ‘关连’(dependencies) 和‘动作’三者所组成的一连串规则。而 make 就会根据 Makefile 的规则来决定如何编译 (compile) 和连结 (link) 程序。实际上，make 可做的不只是编译和连结程序，例如 FreeBSD 的 port collection 中，Makefile 还可以做到自动下载原始程序套件，解压缩 (extract) ，修补 (patch)，设定，然后编译，安装至系统中。

Makefile 基本构造虽然简单，但是妥善运用这些规则就也可以变出许多不同的花招。却也因此，许多刚开始学习写 Makefile 时会感到没有规范可循，每个人写出来的 Makefile 长得都不太一样，不知道从何下手，而且常常会受限于自己的开发环境，只要环境变量不同或路径改一下，可能 Makefile 就得跟着修改。虽然有 GNU Makefile Conventions (GNU Makefile 惯例) 订出一些使用 GNU 程序设计时撰写 Makefile 的一些标准和规范，但是内容很长又很复杂, 并且经常做些调整，为了减轻程序设计师维护 Makefile 的负担，因此有了 Automake。

程序设计师只需写一些预先定义好的宏 (macro)，交给 Automake 处理后会产生一个可供 Autoconf 使用的 Makefile.in 檔。再配合利用 Autoconf 产生的自动设定檔 configure 即可产生一份符合 GNU Makefile 惯例的 Makeifle 了。

2. 上路之前
在开始试着用 Automake 之前，请先确认你的系统已经安装以下的软件：


1. GNU Automake
2. GNU Autoconf
3. GNU m4
4. perl
5. GNU Libtool (如果你需要产生 shared library)
我会建议你最好也使用 GNU C/C++ 编译器、GNU Make 以及其它 GNU 的工具程序来做为开发的环境，这些工具都是属于 Open Source Software 不仅免费而且功能强大。FreeBSD 有现成的 package 可以直接安装，或着你也可以自行下载这些软件的源文件回来 DIY。

3. 一个简单的例子
Automake 所产生的 Makefile 除了可以做到程序的编译和连结，也已经把如何产生程序文件 (如 manual page, info 檔及 dvi 檔) 的动作，还有把原始程序包装起来以供散布的动作都考虑进去了，所以原始程序所存放的目录架构最好符合 GNU 的标准惯例，接下来我拿 hello.c 来做为例子。

在工作目录下建立一个新的子目录 ``devel''，再在 devel 下建立一个 ``hello'' 的子目录，这个目录将作为我们存放 hello 这个程序及其相关档案的地方：


% mkdir devel
% cd devel

% mkdir hello

% cd hello

用编辑器写个 hello.c 檔，

#include <stdio.h>
int main(int argc, char** argv)

{

printf(``Hello, GNU!\n'');

return 0;

}

接下来就要用 Autoconf 及 Automake 来帮我们产生 Makefile 檔了，

1.
用 autoscan 产生一个 configure.in 的雏型，执行 autoscan 后会产生一个configure.scan 的档案，我们可以用它做为 configure.in 檔的蓝本。

% autoscan
% ls

configure.scan hello.c

2.
编辑 configure.scan 檔，如下所示，并且把它的檔名改成 configure.in

dnl Process this file with autoconf to produce a configure script.
AC_INIT(hello.c)

AM_INIT_AUTOMAKE(hello, 1.0)

dnl Checks for programs.

AC_PROG_CC

dnl Checks for libraries.

dnl Checks for header files.

dnl Checks for typedefs, structures, and compiler characteristics.

dnl Checks for library functions.

AC_OUTPUT(Makefile)

3.
执行 aclocal 和 autoconf ，分别会产生 aclocal.m4 及 configure 两个档案

% aclocal
% autoconf

% ls

aclocal.m4 configure configure.in hello.c

4.
编辑 Makefile.am 檔，内容如下

AUTOMAKE_OPTIONS= foreign
bin_PROGRAMS= hello

hello_SOURCES= hello.c

5.
执行 automake --add-missing ，Automake 会根据 Makefile.am 檔产生一些档案，包含最重要的 Makefile.in

% automake --add-missing
automake: configure.in: installing `./install-sh'

automake: configure.in: installing `./mkinstalldirs'

automake: configure.in: installing `./missing'

6.
最后执行 ./configure ，

% ./configure
creating cache ./config.cache

checking for a BSD compatible install... /usr/bin/install -c

checking whether build environment is sane... yes

checking whether make sets ${MAKE}... yes

checking for working aclocal... found

checking for working autoconf... found

checking for working automake... found

checking for working autoheader... found

checking for working makeinfo... found

checking for gcc... gcc

checking whether the C compiler (gcc ) works... yes

checking whether the C compiler (gcc ) is a cross-compiler... no

checking whether we are using GNU C... yes

checking whether gcc accepts -g... yes

updating cache ./config.cache

creating ./config.status

creating Makefile

现在你的目录下已经产生了一个 Makefile 檔，下个 ``make'' 指令就可以开始编译 hello.c 成执行档，执行 ./hello 和 GNU 打声招呼吧！

% make
gcc -DPACKAGE=\"hello\" -DVERSION=\"1.0\" -I. -I. -g -O2 -c hello.c

gcc -g -O2 -o hello hello.o

% ./hello

Hello! GNU!

你还可以试试 ``make clean''，''make install''，''make dist'' 看看会有什么结果。你也可以把产生出来的 Makefile 秀给你的老板，让他从此对你刮目相看  

4. 一探究竟
上述产生 Makefile 的过程和以往自行编写的方式非常不一样，舍弃传统自行定义 make 的规则，使用 Automake 只需用到一些已经定义好的宏即可。我们把宏及目标 (target) 写在 Makefile.am 檔内，Automake 读入 Makefile.am 档后会把这一串已经定义好的宏展开并且产生对应的 Makefile.in 檔，然后再由 configure 这个 shell script 根据 Makefile.in 产生适合的 Makefile。

[Figure 1:利用 autoconf 及 automake 产生 Makefile 的流程]


上图中表示在上一节范例中所要用的档案以及产生出来的档案，有星号 (*) 者代表可执行档。在此范例中可借由 Autoconf 及 Automake 工具所产生的档案有 configure.scan、aclocal.m4、configure、Makefile.in，需要我们加入设定者为 configure.in 及 Makefile.am。


4.1 编辑 configure.in 檔
Autoconf 是用来产生 'configure' 檔的工具。'configure' 是一个 shell script，它可以自动设定原始程序以符合各种不同平台上 Unix 系统的特性，并且根据系统参数及环境产生合适的 Makefile 檔或是C 的标头檔 (header file)，让原始程序可以很方便地在这些不同的平台上被编译出来。Autoconf 会读取 configure.in 檔然后产生 'configure' 这个 shell script。

configure.in 文件的内容是一连串 GNU m4 的宏，这些宏经过 autoconf 处理后会变成检查系统特征的 shell script。configure.in 内宏的顺序并没有特别的规定，但是每一个 configure.in 文件必须在所有宏前加入 AC_INIT 宏，然后在所有宏的最后面加上 AC_OUTPUT 宏。我们可先用 autoscan 扫描原始文件以产生一个 configure.scan 檔，再对 configure.scan 做些修改成 configure.in 檔。在范例中所用到的宏如下：


dnl
这个宏后面的字不会被处理，可视为注解。
AC_INIT(FILE)
这个宏用来检查原始码所在的路径，autoscan 会自动产生，我们不必修改它。
AM_INIT_AUTOMAKE(PACKAGE,VERSION)
这是使用 Automake 所必备的宏，PACKAGE 是我们所要产生软件套件的名称，VERSION 是版本编号。
AC_PROG_CC
检查系统可用的 C 编译器，如果原始程序是用 C 写的就需要这个宏。
AC_OUTPUT(FILE)
设定 configure 所要产生的档案，如果是 Makefile 的话，configure 便会把它检查出来的结果带入 Makefile.in 檔然后产生合适的 Makefile。
实际上，我们使用 Automake 时，还须要一些其它的宏，这些额外的宏我们用 aclocal 来帮我们产生。执行 aclocal 会产生 aclocal.m4 檔，如果没有特别的用途，我们可以不必修改它，用 aclocal 所产生的宏会告诉 Automake 怎么做。
有了 configure.in 及 aclocal.m4 两个档案后，便可以执行 autoconf 来产生 configure 檔了。


4.2 编辑 Makefile.am 檔
接下来我们要编辑 Makefile.am 檔，Automake 会根据 configure.in 中的宏把Makefile.am 转成 Makefile.in 檔。Makefile.am 文件定义我们所要产的目标：


AUTOMAKE_OPTIONS
设定 automake 的选项。Automake 主要是帮助开发 GNU 软件的人员维护软件套件，所以在执行 automake 时，会检查目录下是否存在标准 GNU 软件套件中应具备的档档案，例如 'NEWS'、'AUTHOR'、'ChangeLog' 等文件檔。设成 foreign 时，automake 会改用一般软件套件的标准来检查。
bin_PROGRAMS
定义我们所要产生的执行档档名。如果要产生多个执行档，每个檔名用空格符隔开。
hello_SOURCES
定义 'hello' 这个执行档所需要的原始檔。如果 'hello' 这个程序是由多个原始檔所产生，必须把它所用到的原始檔都列出来，以空格符隔开。假设 'hello' 这个程序需要 'hello.c'、'main.c'、'hello.h' 三个档案的话，则定义

hello_SOURCES= hello.c main.c hello.h
如果我们定义多个执行档，则对每个执行档都要定义相对的 filename_SOURCES。

编辑好 Makefile.am 檔，就可以用 automake -add-missing 来产生 Makefile.in。加上 -add-missing 选项是告诉 automake 顺便帮我们加入包装一个软件套件所必备的档案。Automake 产生出来的 Makefile.in 檔是完全符合 GNU Makefile 的惯例，我们只要执行 configure 这个 shell script 便可以产生合适的 Makefile 檔了。

4.3 使用 Makefile
利用 configure 所产生的 Makefile 檔有几个预设的目标可供使用，我们只拿其中几个简述如下：


make all
产生我们设定的目标，即此范例中的执行文件。只打 make 也可以，此时会开始编译原始码，然后连结，并且产生执行档。
make clean
清除之前所编译的执行档及目的檔 (object file, *.o)。
make distclean
除了清除执行档和目的檔外，也把 configure 所产生的 Makefile 也清除掉。
make install
将程序安装至系统中。如果原始码编译无误，且执行结果正确，便可以把程序安装至系统预设的执行文件存放路径。如果我们用 bin_PROGRAMS 宏的话，程序会被安装至 /usr/local/bin 这个目录。
make dist
将程序和相关的档案包装成一个压缩檔以供散播 (distribution) 。执行完在目录下会产生一个以 PACKAGE-VERSION.tar.gz 为名称的档案。PACKAGE 和 VERSION 这两个变量是根据 configure.in 檔中 AM_INIT_AUTOMAKE(PACKAGE, VERSION) 的定义。在此范例中会产生 'hello-1.0.tar.gz' 的档案。
make distcheck
和 make dist 类似，但是加入检查包装后的压缩檔是否正常。这个目标除了把程序和相关档案包装成 tar.gz 檔外，还会自动把这个压缩檔解开，执行 configure，并且进行 make all 的动作，确认编译无误后，会显示这个 tar.gz 檔已经准备好可供散播了。这个检查非常有用，检查过关的套件，基本上可以给任何一个具备 GNU 发展环境的人去重新编译。就 hello-1.tar.gz 这个范例而言，除了在 Red Hat Linux 上，在 FreeBSD 2.2.x 版也可以正确地重新编译。
要注意的是，利用 Autoconf 及 Automake 所产生出来的软件套件是可以在没有安装 Autoconf 及 Automake 的环境上使用的，因为 configure 是一个 shell script，它己被设计可以在一般 Unix 的 sh 这个 shell 下执行。但是如果要修改 configure.in 及 Makefile.am 檔再产生新的 configure 及 Makefile.in 檔时就一定要有 Autoconf 及 Automake 了。

5. 相关讯息
Autoconf 和 Automake 功能十分强大，你可以从它们所附的 info 檔找到详细的用法。你也可以从许多现存的 GNU 软件或 Open Source 软件中找到相关的 configure.in 或 Makefile.am 檔，它们是学习 Autoconf 及 Automake 更多技巧的最佳范例。

这篇简介只用到了 Autoconf 及 Automake 的皮毛罢了，如果你有心加入 Open Source 软件开发的行列，希望这篇檔能帮助你对产生 Makefile 有个简单的依据。其它有关开发 GNU 程序或 C 程序设计及 Makefile 的详细运用及技巧，我建议你从 GNU Coding Standards3 (GNU 编码标准规定) 读起，里面包含了 GNU Makefile 惯例，还有发展 GNU 软件套件的标准程序和惯例。这些 GNU 软件的在线说明文件可以在 http://www.gnu.org/ 这个网站上找到。

6. 结语
经由 Autoconf 及 Automake 的辅助，产生一个 Makefile 似乎不再像以前那么困难了，而使用 Autoconf 也使得我们在不同平台上或各家 Unix 之间散播及编译程序变得简单，这对于在 Unix 系统上开发程序的人员来说减轻了许多负担。妥善运用这些 GNU 的工具软件，可以帮助我们更容易去发展程序，而且更容易维护原始程序代码。

一九九八年是 Open Source 运动风起云涌的一年，许多 Open Source 的软件普遍受到网络上大众的欢迎和使用。感谢所有为 Open Source 奉献的人们，也希望借由本文能吸引更多的人加入‘自由’、‘开放’的 Open Source 行列。