自動生成 Makefile 的全過程詳解！ automake/autoconf 入門

automake/autoconf 入門
作爲Linux 下的程序開發人員，大家一定都遇到過Makefile ，用make 命令來編譯自己寫的程序確實是很方便。一般情況下，大家都是手工寫一個簡單Makefile ，如果要想寫出一個符合自由軟件慣例的Makefile 就不那麼容易了。

在本文中，將給大家介紹如何使用autoconf 和automake 兩個工具來幫助我們自動地生成符合自由軟件慣例的Makefile ，這樣就可以象常 見的GNU 程序一樣，只要使用“./configure” ，“make” ，“make instal” 就可以把程序安裝到Linux 系統中去了。這將特別適合想做開放源代碼軟件的程序開發人員，又或如果你只是自己寫些小的Toy 程序，那麼這 個文章對你也會有很大的幫助。

一、Makefile 介紹

Makefile 是用於自動編譯和鏈接的，一個工程有很多文件組成，每一個文件的改變都會導致工程的重新鏈接，但是不是所有的文件都需要重新編譯，Makefile 中紀錄有文件的信息，在make 時會決定在鏈接的時候需要重新編譯哪些文件。

Makefile 的宗旨就是：讓編譯器知道要編譯一個文件需要依賴其他的哪些文件。當那些依賴文件有了改變，編譯器會自動的發現最終的生成文件已經過時，而重新編譯相應的模塊。

Makefile 的基本結構不是很複雜，但當一個程序開發人員開始寫Makefile 時，經常會懷疑自己寫的是否符合慣例，而且自己寫的 Makefile 經常和自己的開發環境相關聯，當系統環境變量或路徑發生了變化後，Makefile 可能還要跟着修改。這樣就造成了手工書寫 Makefile 的諸多問題，automake 恰好能很好地幫助我們解決這些問題。

使用automake ，程序開發人員只需要寫一些 簡單的含有預定義宏的文件，由autoconf 根據一個宏文件生成configure ，由automake 根據另一個宏文件生成Makefile.in ， 再使用configure 依據Makefile.in 來生成一個符合慣例的Makefile 。下面我們將詳細介紹Makefile 的automake 生成 方法。

二、使用的環境

本文所提到的程序是基於Linux 發行版本：Fedora Core release 1 ，它包含了我們要用到的autoconf ，automake 。

三、從helloworld 入手

我們從大家最常使用的例子程序helloworld 開始。

下面的過程如果簡單地說來就是：

新建三個文件：

helloworld.c
configure.in
Makefile.am

然後執行：

aclocal; autoconf; automake --add-missing; ./configure; make; ./helloworld

就可以看到Makefile 被產生出來，而且可以將helloworld.c 編譯通過。

很簡單吧，幾條命令就可以做出一個符合慣例的Makefile ，感覺如何呀。

現在開始介紹詳細的過程：

1 、建目錄

在你的工作目錄下建一個helloworld 目錄，我們用它來存放helloworld 程序及相關文件，如在/home/my/build 下：

$ mkdir helloword
$ cd helloworld

2 、 helloworld.c

然後用你自己最喜歡的編輯器寫一個hellowrold.c 文件，如命令：vi helloworld.c 。使用下面的代碼作爲helloworld.c 的內容。

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

完成後保存退出。

現在在helloworld 目錄下就應該有一個你自己寫的helloworld.c 了。

3 、生成configure

我們使用autoscan 命令來幫助我們根據目錄下的源代碼生成一個configure.in 的模板文件。

命令：

$ autoscan
$ ls
configure.scan helloworld.c

執行後在hellowrold 目錄下會生成一個文件：configure.scan ，我們可以拿它作爲configure.in 的藍本。

現在將configure.scan 改名爲configure.in ，並且編輯它，按下面的內容修改，去掉無關的語句：

============================configure.in 內容開始=========================================
# -*- Autoconf -*-
# Process this file with autoconf to produce a configure script.

AC_INIT(helloworld.c)
AM_INIT_AUTOMAKE(helloworld, 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)
============================configure.in 內容結束=========================================

然後執行命令aclocal 和autoconf ，分別會產生aclocal.m4 及configure 兩個文件：

$ aclocal
$ls
aclocal.m4 configure.in helloworld.c
$ autoconf
$ ls
aclocal.m4 autom4te.cache configure configure.in helloworld.c


大家可以看到configure.in 內容是一些宏定義，這些宏經autoconf 處理後會變成檢查系統特性、環境變量、軟件必須的參數的shell 腳本。

autoconf 是用來生成自動配置軟件源代碼腳本（configure ）的工具。configure 腳本能獨立於autoconf 運行，且在運行的過程中，不需要用戶的干預。

要生成configure 文件，你必須告訴autoconf 如何找到你所用的宏。方式是使用aclocal 程序來生成你的aclocal.m4 。

aclocal 根據configure.in 文件的內容，自動生成aclocal.m4 文件。aclocal 是一個perl 腳本程序，它的定義是：“aclocal - create aclocal.m4 by scanning configure.ac” 。

autoconf 從configure.in 這個列舉編譯軟件時所需要各種參數的模板文件中創建configure 。

autoconf 需要GNU m4 宏處理器來處理aclocal.m4 ，生成configure 腳本。

m4 是一個宏處理器。將輸入拷貝到輸出，同時將宏展開。宏可以是內嵌的，也可以是用戶定義的。除了可以展開宏，m4 還有一些內建的函數，用來引用文件，執行命令，整數運算，文本操作，循環等。m4 既可以作爲編譯器的前端，也可以單獨作爲一個宏處理器。

4 、新建Makefile.am

新建Makefile.am 文件，命令：


$ vi Makefile.am


內容如下:


AUTOMAKE_OPTIONS=foreign
bin_PROGRAMS=helloworld
helloworld_SOURCES=helloworld.c


automake 會根據你寫的Makefile.am 來自動生成Makefile.in 。

Makefile.am 中定義的宏和目標, 會指導automake 生成指定的代碼。例如，宏bin_PROGRAMS 將導致編譯和連接的目標被生成。

5 、運行automake

命令：


$ automake --add-missing
configure.in: installing `./install-sh'
configure.in: installing `./mkinstalldirs'
configure.in: installing `./missing'
Makefile.am: installing `./depcomp'


automake 會根據Makefile.am 文件產生一些文件，包含最重要的Makefile.in 。

6 、執行configure 生成Makefile


$ ./configure
checking for a BSD-compatible install... /usr/bin/install -c
checking whether build environment is sane... yes
checking for gawk... gawk
checking whether make sets $(MAKE)... yes
checking for gcc... gcc
checking for C compiler default output... a.out
checking whether the C compiler works... yes
checking whether we are cross compiling... no
checking for suffix of executables...
checking for suffix of object files... o
checking whether we are using the GNU C compiler... yes
checking whether gcc accepts -g... yes
checking for gcc option to accept ANSI C... none needed
checking for style of include used by make... GNU
checking dependency style of gcc... gcc3
configure: creating ./config.status
config.status: creating Makefile
config.status: executing depfiles commands
$ ls -l Makefile
-rw-rw-r-- 1 yutao yutao 15035 Oct 15 10:40 Makefile


你可以看到，此時Makefile 已經產生出來了。

7 、使用Makefile 編譯代碼



$ make
if gcc -DPACKAGE_NAME="" -DPACKAGE_TARNAME="" -DPACKAGE_VERSION="" -

DPACKAGE_STRING="" -DPACKAGE_BUGREPORT="" -DPACKAGE="helloworld" -DVERSION="1.0"

-I. -I. -g -O2 -MT helloworld.o -MD -MP -MF ".deps/helloworld.Tpo" /
-c -o helloworld.o `test -f 'helloworld.c' || echo './'`helloworld.c; /
then mv -f ".deps/helloworld.Tpo" ".deps/helloworld.Po"; /
else rm -f ".deps/helloworld.Tpo"; exit 1; /
fi
gcc -g -O2 -o helloworld helloworld.o


運行helloworld



$ ./helloworld
Hello, Linux World!


這樣helloworld 就編譯出來了，你如果按上面的步驟來做的話，應該也會很容易地編譯出正確的helloworld 文件。你還可以試着使用一些其 他的make 命令，如make clean ，make install ，make dist ，看看它們會給你什麼樣的效果。感覺如何？自己也能寫出這麼專業的Makefile ，老闆一定會對你刮目相看。

四、深入淺出

針對上面提到的各個命令，我們再做些詳細的介紹。

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” 。

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 文件了。

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 ，來確認編譯不出現錯誤，最後提示你軟件包已經準備好，可以發佈了。

===============================================
helloworld-1.0.tar.gz is ready for distribution
===============================================
make distclean

類似make clean ，但同時也將configure 生成的文件全部刪除掉，包括Makefile 。

五、結束語

通過上面的介紹，你應該可以很容易地生成一個你自己的符合GNU 慣例的Makefile 文件及對應的項目文件。

如果你想寫出更復雜的且符合慣例的Makefile ，你可以參考一些開放代碼的項目中的configure.in 和Makefile.am 文件，比如：嵌入式數據庫sqlite ，單元測試cppunit 。 自：http://conkeyn.javaeye.com/blog/337669