关于makefile的编写规范

一个完整的makefile（例子）：
 
如果要生成与前边的.o一样的名字，请使用-o参数特别指定一下，否则会声称与cpp文件名字一样的.o文件。

edit : main.o kbd.o command.o display.o /

• insert.o search.o files.o utils.o
  • cc -o edit main.o kbd.o command.o display.o /
    • insert.o search.o files.o utils.o
• main.o : main.c defs.h
• cc -c main.c
• kbd.o : kbd.c defs.h command.h
  • cc -c kbd.c
  command.o : command.c defs.h command.h
  • cc -c command.c
  display.o : display.c defs.h buffer.h
  • cc -c display.c
  insert.o : insert.c defs.h buffer.h
  • cc -c insert.c
  search.o : search.c defs.h buffer.h
  • cc -c search.c
  files.o : files.c defs.h buffer.h command.h
  • cc -c files.c
  utils.o : utils.c defs.h
  • cc -c utils.c
  clean :
  • rm edit main.o kbd.o command.o display.o /
    • insert.o search.o files.o utils.o

反 斜杠（/）是换行符的意思。这样比较便于Makefile的易读。我们可以把这个内容保存在文件为“Makefile”或“makefile”的文件中， 然后在该目录下直接输入命令“make”就可以生成执行文件edit。如果要删除执行文件和所有的中间目标文件，那么，只要简单地执行一下“make clean”就可以了。

在 这个makefile中，目标文件（target）包含：执行文件edit和中间目标文件（*.o），依赖文件（prerequisites）就是冒号后 面的那些 .c 文件和 .h文件。每一个 .o 文件都有一组依赖文件，而这些 .o 文件又是执行文件 edit 的依赖文件。依赖关系的实质上就是说明了目标文件是由哪些文件生成的，换言之，目标文件是哪些文件更新的。

在 定义好依赖关系后，后续的那一行定义了如何生成目标文件的操作系统命令，一定要以一个Tab键作为开头。记住，make并不管命令是怎么工作的，他只管执 行所定义的命令。make会比较targets文件和prerequisites文件的修改日期，如果prerequisites文件的日期要比 targets文件的日期要新，或者target不存在的话，那么，make就会执行后续定义的命令。

这 里要说明一点的是，clean不是一个文件，它只不过是一个动作名字，有点像C语言中的lable一样，其冒号后什么也没有，那么，make就不会自动去 找文件的依赖性，也就不会自动执行其后所定义的命令。要执行其后的命令，就要在make命令后明显得指出这个lable的名字。这样的方法非常有用，我们 可以在一个makefile中定义不用的编译或是和编译无关的命令，比如程序的打包，程序的备份，等等。

2.make是如何工作的

在默认的方式下，也就是我们只输入make命令。那么，

• 1、 make会在当前目录下找名字叫“Makefile”或“makefile”的文件。 2、如果找到，它会找文件中的第一个目标文件（target），在上面的例子中，他会找到“edit”这个文件，并把这个文件作为最终的目标文件。 3、如果edit文件不存在，或是edit所依赖的后面的 .o 文件的文件修改时间要比edit这个文件新，那么，他就会执行后面所定义的命令来生成edit这个文件。 4、如果edit所依赖的.o文件也存在，那么make会在当前文件中找目标为.o文件的依赖性，如果找到则再根据那一个规则生成.o文件。（这有点像一 个堆栈的过程） 5、当然，你的C文件和H文件是存在的啦，于是make会生成 .o 文件，然后再用 .o 文件生命make的终极任务，也就是执行文件edit了。

这 就是整个make的依赖性，make会一层又一层地去找文件的依赖关系，直到最终编译出第一个目标文件。在找寻的过程中，如果出现错误，比如最后被依赖的 文件找不到，那么make就会直接退出，并报错，而对于所定义的命令的错误，或是编译不成功，make根本不理。make只管文件的依赖性，即，如果在我 找了依赖关系之后，冒号后面的文件还是不在，那么对不起，我就不工作啦。

通过上述分析，我们知道，像clean这种，没有被第一个目标文件直接或间接关联，那么它后面所定义的命令将不会被自动执行，不过，我们可以显示要make执行。即命令——“make clean”，以此来清除所有的目标文件，以便重编译。

于 是在我们编程中，如果这个工程已被编译过了，当我们修改了其中一个源文件，比如file.c，那么根据我们的依赖性，我们的目标file.o会被重编译 （也就是在这个依性关系后面所定义的命令），于是file.o的文件也是最新的啦，于是file.o的文件修改时间要比edit要新，所以edit也会被 重新链接了（详见edit目标文件后定义的命令）。

而如果我们改变了“command.h”，那么，kdb.o、command.o和files.o都会被重编译，并且，edit会被重链接。

3.makefile中使用变量

在上面的例子中，先让我们看看edit的规则：

• edit : main.o kbd.o command.o display.o /
  • insert.o search.o files.o utils.o
  • cc -o edit main.o kbd.o command.o display.o /
    • insert.o search.o files.o utils.o

我 们可以看到[.o]文件的字符串被重复了两次，如果我们的工程需要加入一个新的[.o]文件，那么我们需要在两个地方加（应该是三个地方，还有一个地方在 clean中）。当然，我们的makefile并不复杂，所以在两个地方加也不累，但如果makefile变得复杂，那么我们就有可能会忘掉一个需要加入 的地方，而导致编译失败。所以，为了makefile的易维护，在makefile中我们可以使用变量。makefile的变量也就是一个字符串，理解成 C语言中的宏可能会更好。

比如，我们声明一个变量，叫objects, OBJECTS, objs, OBJS, obj, 或是 OBJ，反正不管什么啦，只要能够表示obj文件就行了。我们在makefile一开始就这样定义：

• objects = main.o kbd.o command.o display.o /
  • insert.o search.o files.o utils.o

于是，我们就可以很方便地在我们的makefile中以“$(objects)”的方式来使用这个变量了，于是我们的改良版makefile就变成下面这个样子：

objects = main.o kbd.o command.o display.o /

• insert.o search.o files.o utils.o

edit : $(objects)

• cc -o edit $(objects)
• main.o : main.c defs.h
  • cc -c main.c
  kbd.o : kbd.c defs.h command.h
  • cc -c kbd.c
  command.o : command.c defs.h command.h
  • cc -c command.c
  display.o : display.c defs.h buffer.h
  • cc -c display.c
  insert.o : insert.c defs.h buffer.h
  • cc -c insert.c
  search.o : search.c defs.h buffer.h
  • cc -c search.c
  files.o : files.c defs.h buffer.h command.h
  • cc -c files.c
  utils.o : utils.c defs.h
  • cc -c utils.c
  clean :
  • rm edit $(objects)

于是如果有新的 .o 文件加入，我们只需简单地修改一下 objects 变量就可以了。

4.让make自动推导

GNU的make很强大，它可以自动推导文件以及文件依赖关系后面的命令，于是我们就没必要去在每一个[.o]文件后都写上类似的命令，因为，我们的make会自动识别，并自己推导命令。

只要make看到一个[.o]文件，它就会自动的把[.c]文件加在依赖关系中，如果make找到一个whatever.o，那么whatever.c，就会是whatever.o的依赖文件。并且 cc -c whatever.c 也会被推导出来，于是，我们的makefile再也不用写得这么复杂。

objects = main.o kbd.o command.o display.o /

• insert.o search.o files.o utils.o

edit : $(objects)

• cc -o edit $(objects)
• main.o : defs.h kbd.o : defs.h command.h command.o : defs.h command.h display.o : defs.h buffer.h insert.o : defs.h buffer.h search.o : defs.h buffer.h files.o : defs.h buffer.h command.h utils.o : defs.h
• PHONY : clean clean :
  • rm edit $(objects)

其中，为了避免和文件重名的这种情况，我们可以使用一个特殊的标记“.PHONY”来显示地指明一个目标是“伪目标”，向make说明，不管是否有这个文件，这个目标就是“伪目标”。

• PHONY : clean

只要有这个声明，不管是否有“clean”文件，要运行“clean”这个目标，只有“make clean”这样。

也可以写成：

• PHONY : clean
  • clean :
    • -rm edit $(objects)

在rm命令前面加了一个小减号的意思就是，也许某些文件出现问题，但不要管，继续做后面的事。当然，clean的规则不要放在文件的开头，不然，这就会变成make的默认目标，相信谁也不愿意这样。不成文的规矩是——“clean从来都是放在文件的最后”。