BBS水木清华站∶精华区

发信人: raner (毕设好无聊呀!), 信区: Linux
标  题: 如何写一个简单的Makefile mini-HOWTO
发信站: BBS 水木清华站 (Fri Jun 19 09:05:43 1998)

发信人: hey (吟风·魂之利刃), 信区: Unix
标  题: [HOWTO] 如何写一个简单的Makefile
发信站: 华南网木棉站 (Thu Jun 18 09:51:56 1998), 转信

第一章如何写一个简单的Makefile

                        描述档案(Description File)

                     检查附属档案(Dependency Checking)

                  重建最小化(Minimizing Rebuilds)

引用make (Invoking make)

            语法的基本规则(Basic Rules of Syntax)

当我们在提示符号之下下一个命令:

$ make program

就是说你要去”make”一个新版本□而且通常是最新版本□的程式. 如果这个程式
是一个执行档,你所下的这个命令意思就是说你想要完成有所必须的编译
(compiling)与连结(linking),然后糟出一一个执行档. 你可以使用make来使这些程
序自动化,不必不断键入为数可观的gcc(or cc)这些编译器指令.

当我们讨论make的时候,我们把我们所要建造的程式(program)称做目标(target).
程式是由一个或一个以上的档案汇集在一起所建造出来的,这些档案的关系分为必备
档案(prerequisites)与附属档案(dependents). 每一个构成程式的档案依序有他们
自己的必备档案和附属档案.

例如,你藉由连结建造了可执行档. 一旦你的原始档(source file)或标头档(head
file)改变了,你就必须再连结新的可执行档之前重新编译目的档(object file). 每
一个原始档都是一个目的档的必备档案.

Make的优点就是它对附属的阶层关系是非常敏感的,像是原始档->目的档,目的档->
可执行档. 你负责在描述档(description file)中指定一些附属档案,这个描述档的
档名通常为makefile 或是Makefile. 但是make也知道自己所在的执行环境,它也会
自己决定许多它自己的附属档案. make会利用档案的档名,这些档案最近修改的时
间,和一些内建的规则,决定编译时要使用哪些档案与如何去建立它们. 在这样的技
术背景之下,之前所秀的那个简单的make指令会保证在阶层中所有建造目标时必须存
在的部分都会被更新.

　

描述档案(Description File)

假设你写了一个程式,程式由以下部分所组成:

*用C语言写的原始档□ main.c iodat.c dorun.c

*用组合语言写的程式码□lo.s ,此档案被C写成的原始档所呼叫

*一组位于 /usr/fred/lib/crtn.a 之中的函式库常式(library routine)

如果你用手一一下指令建造这个程式,你会在提示符号下打入:

$cc □c main.c

$cc □c iodat.c

$cc □c dorun.c

$as □0 lo.o lo.s

$cc □o program main.o iodat.o dorun.o lo.o /usr/fred/lib/crtn.a

当然你也可以在一行cc命令之内就做好编译,组译,连结的工作(要下很长的一串指
令),但是在实际的程式设计环境下这是很少发生的(因为指令实在是又长又复杂),因
为以下原因: 首先,每一个原始档都可能被不同的人所建立或测试. 第二,一个大程
式会花掉好几小时的编译工作,所以程式设计师一般都会尽可能的使用已经存在的目
的档而不要再重新编译(可以节省时间).

现在让我们来看看如何透过描述档下指令给make. 我们建立了一个新的档案叫做
makefile,这个档案和所有的原始码放在同一个目录之下. 为了方便起见,这个描述
档中的每一个指令和附属档案都明显的打出来(后面的章节会告诉你不用写的那么详
细也可以),很多对make来说都是不需要的. 这个描述档的内容如下:

  1.program : main.o iodat.o dorun.o lo.o /usr/fred/lib/crtn.a
  2.cc □o program main.o iodat.o dorun.o lo.o
/usr/fred/lib/ctrn.a
  3.main.o : main.c
  4.cc □c main.c
  5.iodat.o : iodat.c
  6.cc □c iodat.c
  7.dorun.o : dorun.c
  8.cc □c dorun.c
  9.lo.o : lo.s
10.as □0 lo.o lo.s

在每一行左边的数字并不属于描述档的一部份,只是为了待会解说方便

这个描述档中包含了五个项目(或说是进入点)(entry). 每一个项目由一个含有冒号
(:)(叫做附属列[dependency line]或是规则列[rules line]),和一个或一个以上以
tab(4个字元空白)开头的命令列(command line). 在附属行那个冒号左边的叫做目
标(target);冒号左边的就是目标的必备档案. 受tab影响的(tab-indented)命令列,
告诉make如何从他们的必须档案中建造出目标.从上面的描述档来看,第1列说明了
program这个目标依靠main.o,iodat.o,dorun.o,lo.o这些目的档,还有依靠函式库
/usr/fred/lib/crtn.a .第2列指定了从必备档案制造program这个目标档案所必须
下的编译器指令.(这些档案都是目的档与函式库,所以实际上并不用编译,只呼叫了
连结器(linker)而已). 假设program这的目标档案不存在,你可以下这个指令:

$make program

make会去执行第二行的命令. 如果其中一个目的档不在该怎么办呢? 你能够把这个
目的档当作参数传给make(例如:没有main.o ,你可以下指令$make main.o ,就可以
得到main.o这个档案),但是几乎不必这样做. Make最重要的贡献就在于它有能力可
以自己决定什么东西必须被建立(例如:在建立program时,如果少了main.o,则他会根
据附属列所指定的内容,自己建立main.o这个档案).

　

检查附属档案(Dependency Checking)

当你要求make去建造program这个目标时,make会去参考前面所列出的那一个描述档,
但是,第二列的编译器指令并不会立刻就执行. make所做的动作应该如下: 首
先,make先去检查目录下是否有program这个档案,如果有的话,make会去检查main.o
, iodat.o , dorun.o , lo.o , 还有/usr/fred/lib/crtn.a 这些档案,看看这些档
案有没有比program这个档案更新(更新的意思是说,这些档案比program这个档案建
造的时间更晚). 这个动作非常容易,因为作业系统会储存每一个档案最近被修改的
时间,你只要下一个指令ls □l就可以看到这个讯息. 如果program的建造时间比它
所有的必备档案的最近修改时间还要晚,make会决定不再重新建造program这个档案,
然后不会发出认何指令就离开(跳回提示符号下). 但是在make下这个决定之前,它还
会做一些检查: make会根据附属列所描述的必备档案,去检查每一个 .o档案的必备
档案是否有更新的情形.

例如,从第3列就可以看出main.o的建造必须依靠main.c. 因此,如果再main.o被建造
之后,main.c才又被修改,则make就会去执行第4列的指令重新建造一个新的main.o.
只有在program的必备档都被检查而且更新过(这必备档的必备档也要被检查且更新
过. 例如:main.o是program的必备档,main.c是main.o的必备档). make才会去执行
第2列的指令建造program这个目标档案. 假设自从上一次建造program这个档案之
后,iodat.c是唯一被更新过的档案,所以当我们再次执行$make program

之后,make所发出的编译器指令实际上只有

cc □c main.c

cc □o program main.o iodat.o dorun.o lo.o /usr/fred/lib/crtn.a

这两行指令而已.

make命令执行以后,会在标准输出上印出它所发出的指令,因此当你使用make的时候,
你可以从你的萤幕上看到它所发出的命令的顺序.

总而言之,一个程式的建造包含了顺序正确的指令链结(chain). 一般而言,你只要要
求make去建造链结中最后的那个档案即可. make会透过附属档案链结(你在描述档中
所指定的那些必备档案所构成的树状结构构成附属档案链结),自己回朔追踪(traces
back,也就是往树状结构的叶部方向)这个链结,然后找出哪些指令必须被执行. 最
后,make会慢慢在链结中前进(moves forward,就是往数状结构的根部移动),执行每
个建造目标所必须要有的指令直到目标建立完成(或被更新). 因为这种特性,make是
一个使用反项链结法(backward-chaining:在人工智慧领域中,一种搜索问题答案的
方法,它的搜索方向是由目标状态开始,然后向初始状态前进,最后再慢慢回来)这个
技巧最有名的例子,这个技巧通常仅使用在像是Prolog语言这一类大家比较不知道的
环境上.

　

重建最小化(Minimizing Rebuilds)

现在我们来讨论一个可以以各种不同版本形式存在的程式(通常是不同平台,或是不
同作业系统,或是要分散(release)给不同层级使用者的版本),这是一个可以告诉你
make如何节省你的时间,而且可以避免混淆的例子,比前的例子更复杂一点. 假设你
写了一个可以绘出资料的程式,它可以在终端机(文字模式)或是图形介面(例如:X
window)之下执行. 涉及到计算和档案处理的部分在两个版本之中都相同,而且你把
它们都存放在basic.c这个档案中. 处理文字模式下使用者输入的程式放在prompt.c
之中,而处理图形介面上使用者输入的程式放在window.c之中.

因此,这个程式可以以两种不同的版本被发行(release),当你想要建立这个程式时,
你可以选择要建立你觉得最适合你现在工作环境的版本. 以文字模式下的版本来说,
你可以由basic.c与prompt.c这两个档案来产生plot_prompt这个执行档. 对图形介
面的版本来说,你就可以使用basic.c与window.c这两个档案来产生叫做plot_win的
执行档. 以下产生这两种版本所使用的眠述档:

plot_prompt : basic.o prompt.o

cc □o plot_prompt basic.o prompt.o

plot_win : basic.o window.o

cc □o plot_win basic.o window.o

basic.o : basic.c

cc □c basic.c

prompt.o : prompt.c

cc □c prompt.c

window.0 : window.c

cc □c window.c

当你第一次建造其中一个执行档时,你必须编译basic.c这个档案. 但是只要你没有
改变basic.c这个档案,也没有删除掉basic.o的话,下一次你想要重新产生新的图形
介面执行档时,就可以不必再重新编译basic.c. 如果你修改了prompt.c,然后重新建
立plot_prompt的话,make会去检查修改时间,然后就明白只要重新编译prompt.c,然
后再连结就可以了. 也就是说,如果你重新下

$make plot_prompt

这个指令,你会在萤幕上看到下面的结果:

cc □c prompt

cc □o plot_prompt basic.o prompt.o

这这些范例之中的描述档,实际上可以被大量的简化. 因为make 有内建的规则和巨
集(macro)的定义可以用来处理在档案中一再重复出现的附属物(dependencies),例
如”.o”档案的附属档案”.c”档案,他们都是前面的名称相同,只有副档名不同而
已. 在第二章巨集(macro)与第三章后置规则(suffix rule)的时候,我们会讨论这
些make的特色. 在这一章里,我们只把附属(dependency)和更新(updating)的概念传
达给你而已

　

引用make(Invoking make)

前面的几个小节的范例都有以下的假设:

*专案档(project file),也就是描述档,和原始码放在同一个目录底下

*描述档的档名叫做makefile或是Makefile

*将你键入make指令时,工作目录就是这些档案放置的目录

有了这些假设,你只要下一个

$make target

的指令,就可以建立在描述档中的任何一个目标. 建造这个目标所必须要下的指令都
会被显示在终端机上,然后执行. 如果一些中间档案(intermediate file)已经存在
或者已经被更新过,make会掠过建造这些中间档案的指令. make只会发出建造这个目
标所必须执行的最少指令. 如果在上次建造这个目标后,没有任何必备档案被修改或
是移除,make会发出一个讯息

‘target’ is up to date

然后什么事情也不做.

如果你想要建造在描述档中没有指定,而且也不被第三章后置规则(suffix rule)中
所讨论的内定规则所涵盖的目标,例如:你下了一个指令建造一个不存在的目标

$make nottarget

则make会回应:

‘nottarget’ is up to date

或是

make: Don’t know ho to make nontarget. Stop.

如果再目前的工作目录之下真的有nontarget这个档案存在,就会发出上面的第一个
讯息. 第七章问题解决(troubleshooting)时,会解释在不同的环境下,make所发述
的讯息所代表的涵义.

我们可以一次要make建立好几个目标. 这个命令的效果就跟连续的发出好几个make
命令相同,例如:

$make main.o target

就相当于

$make main.o

$make target

一样

我们也可以只简单的打上

$make

没有附上任何的目标名称. 在此情况下,在描述档中的第一个目标将会被建立(同时
他的必备档也会一起被建立)

在命令列下发出make指令有许多的选择项(option,通常前面会加上”-“). 例如,你
可以选择不要在终端机上印出make所发出的命令. 反过来说,你也可以要求印出哪些
命令会被执行,而实际上并没有执行它们. 这些都会在第六章命令列的使用与特别
的目标(Command-line usage and Special targets)中讨论的更仔细.

　

语法的基本规则(Basic Rules of Syntax)

在你开始要尝试写自己的描述档之前,你应该了解一些在make所使用的一些难懂的条
件(requirement),这些条件如果单独从范例中来体会,是不够不清楚的. 完整的语法
描述可以在附录A 快速参考中找到. 这一章只是提供一些入门的技巧而已.

最重要的一条规则就是”每一个命令列的开头都要是一个tab字元(四个空格)”. 一
个常常犯的错误就是在每个命令列的开头省略了tab字元. 就算在每个命令列中按空
白键插入四个空白也不行,因为make无法辨别出这就是tab字元,而且非常不幸的,在
这种情况下,就算出了错误,make也无法提供有用的讯息.

make是靠开头的那个tab字来辨识命令列,所以一定要注意不要在其他不是命令列的
那一列之前加上tab字元. 如果你把tab当作第一个字元加在附属列,注解,或这甚至
是一个空白列之前,你都会得到错误讯息. Tab字元可以用在每一列的任何地方,只有
在每一列的第一个字元才有上述的限制.

如果你想要检查描述档中的tab字元,你可以下指令

$cat □v □t □e makefile

在这里 □v 与 □t会使得描述档中的每一个tab字元以 ^I 的方式印出来,而 □e
会使得每一列的最后以 $ 的样子印出来,所以你可以看出在每一列的结束之前有几
个空白.

你可以打很长一串指令,如果已经到了文字编辑器的右边界,你可以在到达右边界之
前放入一个斜线(\)符号. 你必须确定在新的一列开始之前,会有一个斜线符号在哪
里.斜线符号和新的一行之间不要有空白(don’t let any white space slip in
between). 由斜线符号所连续的每一列都会被当作单独一列来剖析(parsing).

make会忽略描述档中的空白行(blank line). 同样的,它也会忽略掉以 # 符号开头,
到每一列结尾之间的字元,所以 # 符号用来当作每个注解的开头.

命令列跟附属列不一定都要各自占掉一列的空间,你可以写成

plot_prompt : prompt.o ; cc □o plot_prompt prompt.o

虽然之前有说过命令列的开头都要有一个tab字元,不过这里是唯一的例外.

一个单独的目标也可以用多个附属列来表示. 当你为了要易于区分附属档的的种类
时,这是一个很实用的技巧,例如

file.o : file.c

cc □c file.c

……

file.o : global.h defs.h

虽然实际上建造file.o的命令是第一个附属列的下面那一行,即使重新建造
时,file.c并没有被修改,可是如果附属的.h档被修改过的话,file.o仍然会被重新编
译.

如果你使用了多个附属列的技巧,只有其中一个附属列才能有能够伴随有指令列. 但
是如果你在一个附属列中使用了两个冒号(在第三章后置规则时会讨论到,这是一个
在建造函式库时很有用的技巧),则不在此限.

在描述档中可以有”没有附属档案的目标”(但是冒号还是要打上去,不能省略),这
些档案通常不全是档名. 例如,许多描述档含有下面的目标,用来帮助程式设计师在
一天辛苦的测试之后移除暂存档.

clean :

/bin/rm □f core *.o

当我们下指令

$make clean

如果工作目录下没有clean这个档案,make就会去执行claen这个项目下的命令稿
(command script). 这是因为make把每一个不存在的目标当作是一个过时的目标

在每个项目中的命令,就目前来说,应该要是单一一行的Bourne Shell指令.等到你读
了第四章指令(command),不要尝试去使用别名(aliases),环境变数(environment
variables),或是像if或for这一类会有很多行的命令,同时要避免使用cd,第四章会
解释这样做的理由.

现在你已经能够藉由键入你习惯在终端机前打的指令来建立你自己的描述档了. 但
是很快的,你会发现非常的乏味. 往后的两章会解释很多可以让你简化(simplify)与
一般化(generalize)你属于你自己的描述档的方法.

　
　

1998/5/20 interpreted by 王森(moli)

email address e9484402@alpha1.dec.ncku.edu.tw

小弟第一次做翻译的工作,如果有错误的地方,

请来信与我讨论,相信会让下一章的翻译更好

--
※ 来源:·BBS 水木清华站 bbs.net.tsinghua.edu.cn·[FROM: 166.111.68.98]