关于Makefile,Makefile.in,Makefile.am,Configure功能及相互关系的问题

makefile写法

在 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 collect ion 中， 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不仅免费而且功能强大。如果你是使用Red Hat Linux 可以找到所有上述软体的 rpm 档，FreeBSD 也有现成的 package 可以直接安装，或着你也可以自行下载这些软体的原始档回来 DIY。以下的范例是在 Red Hat Linux 5.2 + CLE2 的环境下所完成的。

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档的蓝本。
.
2、编辑 configure.scan 档，如下所示，并且把它的档名改成configure.in
autoconfig用户参考手册 http://www.gnu.org/software/autoconf/manual/autoconf.html
automake用户参考手册 http://www.gnu.org/software/automake/manual/automake.html
修改后的configure.in文件内容如下：

.# -- Autoconf --
.# Process this file with autoconf to produce a configure script.
AC_PREREQ([2.69])
AC_INIT([FULL-PACKAGE-NAME], [VERSION], [BUG-REPORT-ADDRESS])
AM_INIT_AUTOMAKE
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_CONFIG_FILES(Makefile)
AC_OUTPUT

上面以AC开头的宏来自autoconf，以AM开头的宏来自automake。要从autoconf或 automake中寻求帮助，这一点很有用。以GNOME开头的宏来自于Gnomemacros目录。这些宏都是用m4宏语言写的。如果将 autoconf和automake安装在/usr目录下，autoconf和automake中的标准宏一般放在/usr/share/aclocal 目录下。

3、执行 aclocal 和 autoheader ，分别会产生 aclocal.m4 及 configure.h.in 两个档案
% aclocal
% autoheader
注意：要修改文件名

4、编辑 Makefile.am 档，内容如下：

.# cat Makefile.am
AUTOMAKE_OPTIONS = foreign
bin_PROGRAMS = hello
hello_SOURCES = hello.c
hello_CPPFLAGS = -I /usr/include/

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

configure.ac:11: installing ‘./compile’
configure.ac:6: installing ‘./install-sh’
configure.ac:6: installing ‘./missing’
Makefile.am: installing ‘./depcomp’

6. 执行 autoconf 得到 configure可执行脚本文件

% autoconf

7. 执行测试：

执行./configure
执行 make 此时应该已经生成可执行文件，ls看一下
执行 make install

8. 测试程序：#可执行文件
make clean 清除编译过程生成的文件
make uninstall 卸载

4.说明：

4.1、autoscan

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

4.2、 configure.scan

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

4.3、aclocal

aclocal是一个perl 脚本程序.aclocal根据configure.in文件的内容,自动生成aclocal.m4件.aclocal的定义是：“aclocal - create aclocal.m4 by scanning configure.ac”.

4.4、autoconf

autoconf是用来产生configure文件的 .configure是一个脚本,它能设置源程序来适应各种不同的操作系统平台,并且根据不同的系统来产生合适的 Makefile,从而可以使你的源代码能在不同的操作系统平台上被编译出来.configure.in文件的内容是一些宏,这些宏经过autoconf 处理后会变成检查系统
特性.环境变量.软件必须的参数的 shell脚本.configure.in文件中的宏的顺序并没有规定,但是你必须在所有宏的最前面和最后面分别加上AC_INIT宏和AC_OUTPUT宏.
　　在 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文件了.

4.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.

4.6、 automake

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

4.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
　　生成发布软件包并对其进行测试检查,以确定发布包的正确性.