├── .gitignore ├── README.md ├── SUMMARY.md ├── _config.yml ├── docs ├── makefile介绍.md ├── make概述.md ├── make的运行.md ├── 书写命令.md ├── 书写规则.md ├── 使用make更新函数库文件.md ├── 使用变量.md ├── 使用条件判断.md ├── 函数.md ├── 教程.md ├── 教程 │ ├── image │ │ ├── 20191207_113729_47.png │ │ └── 20191207_113957_59.png │ └── 跟我一起写Makefile.md ├── 概述 │ ├── make历史 │ └── make基本原理 └── 隐式规则.md ├── image ├── 1536411318497.png ├── 1536411378639.png ├── 1536411721611.png └── 20191206_115541_14.png ├── mindmap ├── makefile-01.mmap └── makefile-02.mmap ├── reference ├── GNU make v3.80完整版中文指南.pdf ├── GNU make中文手册.pdf ├── GNUake3.80完整版中文指南.docx └── make.pdf └── src └── make-3.75.tar.gz /.gitignore: -------------------------------------------------------------------------------- 1 | *.~$lock 2 | *.o 3 | make-3.75 4 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # GNU make学习笔记 2 | 3 | ![20191206_115541_14](image/20191206_115541_14.png) 4 | 5 | ## 本仓库内容 6 | 7 | 1. GNU make学习笔记 8 | 9 | ``` 10 | Something I hope you know before go into the coding~ 11 | First, please watch or star this repo, I'll be more happy if you follow me. 12 | Bug report, questions and discussion are welcome, you can post an issue or pull a request. 13 | ``` 14 | 15 | ## 相关站点 16 | 17 | * GitHub地址: 18 | * GitBook地址: 19 | * GitPage : 20 | 21 | 22 | ## GNU make简介 23 | 24 | 一个工程中的源文件不计其数，其按类型、功能、模块分别放在若干个目录中，makefile定义了一系列的规则来指定，哪些文件需要先编译，哪些文件需要后编译，哪些文件需要重新编译，甚至于进行更复杂的功能操作，因为**makefile就像一个Shell脚本一样，其中也可以执行操作系统的命令。** 25 | 26 | Linux 环境下的程序员如果不会使用GNU make来构建和管理自己的工程，应该不能算是一个合格的专业程序员，至少不能称得上是 Unix程序员。在 Linux（unix ）环境下使用GNU 的make工具能够比较容易的构建一个属于你自己的工程，整个工程的编译只需要一个命令就可以完成编译、连接以至于最后的执行。不过这需要我们投入一些时间去完成一个或者多个称之为Makefile 文件的编写。 27 | 28 | 所要完成的 **Makefile 文件描述了整个工程的编译、连接等规则**。其中包括：工程中的哪些源文件需要编译以及如何编译、需要创建哪些库文件以及如何创建这些库文件、如何最后产生我们想要的可执行文件。尽管看起来可能是很复杂的事情，但是为工程编写Makefile 的好处是能够使用一行命令来完成“自动化编译”，一旦提供一个（通常对于一个工程来说会是多个）正确的 Makefile。编译整个工程你所要做的唯一的一件事就是在shell 提示符下输入make命令。整个工程完全自动编译，极大提高了效率。 29 | 30 | **make是一个命令工具，它解释Makefile 中的指令（应该说是规则）**。在Makefile文件中描述了整个工程所有文件的编译顺序、编译规则。Makefile 有自己的书写格式、关键字、函数。像C 语言有自己的格式、关键字和函数一样。而且在Makefile 中可以使用系统shell所提供的任何命令来完成想要的工作。Makefile（在其它的系统上可能是另外的文件名）在绝大多数的IDE 开发环境中都在使用，已经成为一种工程的编译方法。 31 | 32 | **make命令本质就是Makefile脚本解释器的角色** 33 | 34 | ## 目录 35 | 36 | * [GNU make](README.md) 37 | * [make概述](docs/make概述.md) 38 | * [make历史](docs/概述/make历史) 39 | * [make基本原理](docs/概述/make基本原理) 40 | * [makefile介绍](docs/makefile介绍.md) 41 | * [书写规则](docs/书写规则.md) 42 | * [书写命令](docs/书写命令.md) 43 | * [使用变量](docs/使用变量.md) 44 | * [使用条件判断](docs/使用条件判断.md) 45 | * [函数](docs/函数.md) 46 | * [make的运行](docs/make的运行.md) 47 | * [隐式规则](docs/隐式规则.md) 48 | * [使用make更新函数库文件](docs/使用make更新函数库文件.md) 49 | 50 | 51 | ## 思维导图 52 | 53 | 54 | 55 | ## 参考教程 56 | 57 | ![1536411318497.png](image/1536411318497.png) 58 | 59 | ![1536411378639.png](image/1536411378639.png) 60 | 61 | 62 | 63 | ![1536411721611.png](image/1536411721611.png) 64 | 65 | * 66 | * 67 | * 68 | 69 | --- 70 | -------------------------------------------------------------------------------- /SUMMARY.md: -------------------------------------------------------------------------------- 1 | # Summary 2 | 3 | * [GNU make](README.md) 4 | * [make概述](docs/make概述.md) 5 | * [make历史](docs/概述/make历史) 6 | * [make基本原理](docs/概述/make基本原理) 7 | * [makefile介绍](docs/makefile介绍.md) 8 | * [书写规则](docs/书写规则.md) 9 | * [书写命令](docs/书写命令.md) 10 | * [使用变量](docs/使用变量.md) 11 | * [使用条件判断](docs/使用条件判断.md) 12 | * [函数](docs/函数.md) 13 | * [make的运行](docs/make的运行.md) 14 | * [隐式规则](docs/隐式规则.md) 15 | * [使用make更新函数库文件](docs/使用make更新函数库文件.md) 16 | * [教程](docs/教程.md) 17 | * [跟我一起写Makefile](docs/教程/跟我一起写Makefile.md) 18 | 19 | -------------------------------------------------------------------------------- /_config.yml: -------------------------------------------------------------------------------- 1 | theme: jekyll-theme-cayman -------------------------------------------------------------------------------- /docs/makefile介绍.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | - [makefile介绍](#makefile介绍) 4 | - [makefile的规则](#makefile的规则) 5 | - [一个示例](#一个示例) 6 | - [make是如何工作的](#make是如何工作的) 7 | - [makefile中使用变量](#makefile中使用变量) 8 | - [让make自动推导](#让make自动推导) 9 | - [另类风格的makefiles](#另类风格的makefiles) 10 | - [清空目标文件的规则-clean目标](#清空目标文件的规则-clean目标) 11 | - [Makefile里有什么？](#makefile里有什么？) 12 | - [Makefile的文件名](#makefile的文件名) 13 | - [引用其它的Makefile](#引用其它的makefile) 14 | - [环境变量MAKEFILES](#环境变量makefiles) 15 | - [make的工作方式](#make的工作方式) 16 | 17 | 18 | # makefile介绍 19 | 20 | make命令执行时，需要一个makefile文件，以告诉make命令需要怎么样的去编译和链接程序。 21 | 22 | 首先，我们用一个示例来说明makefile的书写规则，以便给大家一个感性认识。这个示例来源于gnu 23 | 的make使用手册，在这个示例中，我们的工程有8个c文件，和3个头文件，我们要写一个makefile来告 24 | 诉make命令如何编译和链接这几个文件。我们的规则是： 25 | 26 | 1. 如果这个工程没有编译过，那么我们的所有c文件都要编译并被链接。 27 | 2. 如果这个工程的某几个c文件被修改，那么我们只编译被修改的c文件，并链接目标程序。 28 | 3. 如果这个工程的头文件被改变了，那么我们需要编译引用了这几个头文件的c文件，并链接目标程序。 29 | 30 | 只要我们的makefile写得够好，所有的这一切，我们只用一个make命令就可以完成，make命令会自动智能 31 | 地根据当前的文件修改的情况来确定哪些文件需要重编译，从而自动编译所需要的文件和链接目标程序。 32 | 33 | ## makefile的规则 34 | 35 | 36 | 在讲述这个makefile之前，还是让我们先来粗略地看一看makefile的规则。 37 | 38 | ``` 39 | target ... : prerequisites ... 40 | command 41 | ... 42 | ... 43 | ``` 44 | 45 | 1. target 46 | * 可以是一个object file（目标文件），也可以是一个执行文件，还可以是一个标签（label）。对于标签这种特性，在后续的“伪目标”章节中会有叙述。 47 | 2. prerequisites 48 | * 生成该target所依赖的文件和/或target 49 | 3. command 50 | * 该target要执行的命令（任意的shell命令） 51 | 52 | 这是一个文件的依赖关系，也就是说，target这一个或多个的目标文件依赖于prerequisites中的文件，其生成规则定义在command中。说白一点就是说: 53 | 54 | **prerequisites中如果有一个以上的文件比target文件要新的话，command所定义的命令就会被执行。这就是makefile的规则，也就是makefile中最核心的内容。** 55 | 56 | 说到底，makefile的东西就是这样一点，好像我的这篇文档也该结束了。呵呵。还不尽然，这是makefile的主线和核心，但要写好一个makefile还不够，我会在后面一点一点地结合我的工作经验给你慢慢道来。内 57 | 容还多着呢。 58 | 59 | ## 一个示例 60 | 61 | 正如前面所说，如果一个工程有3个头文件和8个c文件，为了完成前面所述的那三个规则，我们的makefile 62 | 应该是下面的这个样子的。 63 | 64 | ``` 65 | edit : main.o kbd.o command.o display.o \ 66 | insert.o search.o files.o utils.o 67 | cc -o edit main.o kbd.o command.o display.o \ 68 | insert.o search.o files.o utils.o 69 | 70 | main.o : main.c defs.h 71 | cc -c main.c 72 | kbd.o : kbd.c defs.h command.h 73 | cc -c kbd.c 74 | command.o : command.c defs.h command.h 75 | cc -c command.c 76 | display.o : display.c defs.h buffer.h 77 | cc -c display.c 78 | insert.o : insert.c defs.h buffer.h 79 | cc -c insert.c 80 | search.o : search.c defs.h buffer.h 81 | cc -c search.c 82 | files.o : files.c defs.h buffer.h command.h 83 | cc -c files.c 84 | utils.o : utils.c defs.h 85 | cc -c utils.c 86 | clean : 87 | rm edit main.o kbd.o command.o display.o \ 88 | insert.o search.o files.o utils.o 89 | ``` 90 | 91 | **反斜杠（ ``\`` ）是换行符的意思。这样比较便于makefile的阅读，但是务必记住```\```后面不能再有任何字符，不然起不到这个效果而且会报错**。我们可以把这个内容保存在名字为“makefile”或“Makefile”的文件中，然后在该目录下直接输入命令``make`` 就可以生成执行文件edit。如果要删除执行文件和所有的中间目标文件，那么，只要简单地执行一下 ``make clean`` 就可以了。 92 | 93 | 在这个makefile中，目标文件（target）包含：执行文件edit和中间目标文件（ ````*.o``` ），依赖文 94 | 件（prerequisites）就是冒号后面的那些 ```.c``` 文件和 ```.h``` 文件。每一个 ````.o``` 文件都有 95 | 一组依赖文件，而这些 ```.o``` 文件又是执行文件 ```edit``` 的依赖文件。**依赖关系的实质就是说明了目 96 | 标文件是由哪些文件生成的，换言之，目标文件是哪些文件更新的。** 97 | 98 | 在定义好依赖关系后，后续的那一行定义了如何生成目标文件的操作系统命令，**一定要以一个 ``Tab`` 键 99 | 作为开头**。记住，**make并不管命令是怎么工作的，他只管执行所定义的命令**。**make会比较targets文件 100 | 和prerequisites文件的修改日期，如果prerequisites文件的日期要比targets文件的日期要新，或 101 | 者target不存在的话，那么，make就会执行后续定义的命令。** 102 | 103 | 这里要说明一点的是， ``clean`` 不是一个文件，它只不过是一个动作名字，有点像c语言中的label一 104 | 样，其冒号后什么也没有，那么，make就不会自动去找它的依赖性，也就不会自动执行其后所定义的命令。 105 | 要执行其后的命令，就要在make命令后明显得指出这个label的名字。这样的方法非常有用，我们可以在一 106 | 个makefile中定义不用的编译或是和编译无关的命令，比如程序的打包，程序的备份，等等。 107 | 108 | ## make是如何工作的 109 | 110 | 111 | 在默认的方式下，也就是我们只输入 ``make`` 命令。那么， 112 | 113 | 1. make会在当前目录下找名字叫“Makefile”或“makefile”的文件。 114 | 2. 如果找到，它会找文件中的第一个目标文件（target），在上面的例子中，他会找到“edit”这个文件，并把这个文件作为最终的目标文件。 115 | 3. 如果edit文件不存在，或是edit所依赖的后面的 ``.o`` 文件的文件修改时间要比 ``edit`` 这个文件新，那么，他就会执行后面所定义的命令来生成 ``edit`` 这个文件。 116 | 4. 如果 ``edit`` 所依赖的 ``.o`` 文件也不存在，那么make会在当前文件中找目标为 ``.o`` 文件的依赖性，如果找到则再根据那一个规则生成 ``.o`` 文件。（这有点像一个堆栈的过程、递归的过程） 117 | 5. 当然，你的C文件和H文件是存在的啦，于是make会生成 ``.o`` 文件，然后再用 ``.o`` 文件生成make的终极任务，也就是执行文件 ``edit`` 了。 118 | 119 | **这就是整个make的依赖性，make会一层又一层地去找文件的依赖关系，直到最终编译出第一个目标文件。**在 120 | 找寻的过程中，如果出现错误，比如最后被依赖的文件找不到，那么make就会直接退出，并报错，而对于所 121 | 定义的命令的错误，或是编译不成功，make根本不理。**make只管文件的依赖性，即，如果在我找了依赖关系 122 | 之后，冒号后面的文件还是不在，那么对不起，我就不工作啦。先跑到递归的最内层，然后一层一层出来，中间要是断了，就奔溃。** 123 | 124 | 通过上述分析，我们知道，像clean这种，没有被第一个目标文件直接或间接关联，那么它后面所定义的命令将不会被自动执行，不过，我们可以显示要make执行。即命令—— ``make clean`` ，以此来清除所有的目标文件，以便重编译。 125 | 126 | 于是在我们编程中，如果这个工程已被编译过了，当我们修改了其中一个源文件，比如 ``file.c`` ， 127 | 那么根据我们的依赖性，我们的目标 ``file.o`` 会被重编译（也就是在这个依性关系后面所定义的命令）， 128 | 于是 ``file.o`` 的文件也是最新的啦，于是 ``file.o`` 的文件修改时间要比 ``edit`` 要新，所 129 | 以 ``edit`` 也会被重新链接了（详见 ``edit`` 目标文件后定义的命令）。 130 | 131 | 而如果我们改变了 ``command.h`` ，那么， ``kdb.o`` 、 ``command.o`` 和 ``files.o`` 都 132 | 会被重编译，并且， ``edit`` 会被重链接。 133 | 134 | ## makefile中使用变量 135 | 136 | 137 | 在上面的例子中，先让我们看看edit的规则： 138 | 139 | ``` 140 | edit : main.o kbd.o command.o display.o \ 141 | insert.o search.o files.o utils.o 142 | cc -o edit main.o kbd.o command.o display.o \ 143 | insert.o search.o files.o utils.o 144 | ``` 145 | 146 | 我们可以看到 ```.o``` 文件的字符串被重复了两次，如果我们的工程需要加入一个新的 ```.o``` 文件， 147 | 那么我们需要在两个地方加（应该是三个地方，还有一个地方在clean中）。当然，我们的makefile并不复 148 | 杂，所以在两个地方加也不累，但如果makefile变得复杂，那么我们就有可能会忘掉一个需要加入的地方， 149 | 而导致编译失败。所以，为了makefile的易维护，在makefile中我们可以使用变量。makefile的变量也 150 | 就是一个字符串，理解成C语言中的宏可能会更好。 151 | 152 | 比如，我们声明一个变量，叫 ```objects``` ， ```OBJECTS``` ， ```objs``` ， ```OBJS``` ， 153 | ```obj``` 或是 ```OBJ``` ，反正不管什么啦，只要能够表示obj文件就行了。我们在makefile一开始就 154 | 这样定义： 155 | 156 | ``` 157 | objects = main.o kbd.o command.o display.o \ 158 | insert.o search.o files.o utils.o 159 | ``` 160 | 161 | 于是，我们就可以很方便地在我们的makefile中以 ```$(objects)``` 的方式来使用这个变量了，于是 162 | 我们的改良版makefile就变成下面这个样子： 163 | 164 | ``` 165 | objects = main.o kbd.o command.o display.o \ 166 | insert.o search.o files.o utils.o 167 | 168 | edit : $(objects) 169 | cc -o edit $(objects) 170 | main.o : main.c defs.h 171 | cc -c main.c 172 | kbd.o : kbd.c defs.h command.h 173 | cc -c kbd.c 174 | command.o : command.c defs.h command.h 175 | cc -c command.c 176 | display.o : display.c defs.h buffer.h 177 | cc -c display.c 178 | insert.o : insert.c defs.h buffer.h 179 | cc -c insert.c 180 | search.o : search.c defs.h buffer.h 181 | cc -c search.c 182 | files.o : files.c defs.h buffer.h command.h 183 | cc -c files.c 184 | utils.o : utils.c defs.h 185 | cc -c utils.c 186 | clean : 187 | rm edit $(objects) 188 | ``` 189 | 190 | 于是如果有新的 ``.o`` 文件加入，我们只需简单地修改一下 ``objects`` 变量就可以了。 191 | 192 | 关于变量更多的话题，我会在后续给你一一道来。 193 | 194 | ### 让make自动推导 195 | 196 | GNU的make很强大，它可以自动推导文件以及文件依赖关系后面的命令，于是我们就没必要去在每一个 197 | ```.o``` 文件后都写上类似的命令，因为，我们的make会自动识别，并自己推导命令。 198 | 199 | 只要make看到一个 ```.o``` 文件，它就会自动的把 ```.c``` 文件加在依赖关系中，如果make找到一个 200 | ```whatever.o``` ，那么 ```whatever.c``` 就会是 ```whatever.o``` 的依赖文件。并且 201 | ``cc -c whatever.c``` 也会被推导出来，于是，我们的makefile再也不用写得这么复杂。我们的 202 | 新makefile又出炉了。 203 | 204 | ``` 205 | objects = main.o kbd.o command.o display.o \ 206 | insert.o search.o files.o utils.o 207 | 208 | edit : $(objects) 209 | cc -o edit $(objects) 210 | 211 | main.o : defs.h 212 | kbd.o : defs.h command.h 213 | command.o : defs.h command.h 214 | display.o : defs.h buffer.h 215 | insert.o : defs.h buffer.h 216 | search.o : defs.h buffer.h 217 | files.o : defs.h buffer.h command.h 218 | utils.o : defs.h 219 | 220 | .PHONY : clean 221 | clean : 222 | rm edit $(objects) 223 | ``` 224 | 225 | 这种方法，也就是make的“隐晦规则”。如果不指定，则根据自定义规则查找。处处透露程序员偷懒的技巧。 226 | 227 | 上面文件内容中， ``.PHONY`` 表示 ``clean`` 是个伪目标 228 | 文件。关于更为详细的“隐晦规则”和“伪目标文件”，我会在后续给你一一道来。 229 | 230 | ## 另类风格的makefiles 231 | 232 | 既然我们的make可以自动推导命令，那么我看到那堆 ```.o``` 和 ```.h``` 的依赖就有点不爽，那么多的 233 | 重复的 ```.h``` ，能不能把其收拢起来，好吧，没有问题，这个对于make来说很容易，谁叫它提供了自动 234 | 推导命令和文件的功能呢？来看看最新风格的makefile吧。 235 | 236 | ``` 237 | objects = main.o kbd.o command.o display.o \ 238 | insert.o search.o files.o utils.o 239 | 240 | edit : $(objects) 241 | cc -o edit $(objects) 242 | 243 | $(objects) : defs.h 244 | kbd.o command.o files.o : command.h 245 | display.o insert.o search.o files.o : buffer.h 246 | 247 | .PHONY : clean 248 | clean : 249 | rm edit $(objects) 250 | ``` 251 | 252 | **不得使用这种偷懒方式** 253 | 254 | 这种风格，让我们的makefile变得很简单，但我们的文件依赖关系就显得有点凌乱了。鱼和熊掌不可兼得。 255 | 还看你的喜好了。我是不喜欢这种风格的，一是文件的依赖关系看不清楚，二是如果文件一多，要加入几个 256 | 新的 ```.o``` 文件，那就理不清楚了。 257 | 258 | ## 清空目标文件的规则-clean目标 259 | 260 | 每个Makefile中都应该写一个清空目标文件（ ``.o`` 和执行文件）的规则，这不仅便于重编译，也很 261 | 利于保持文件的清洁。这是一个“修养”（呵呵，还记得我的《编程修养》吗）。一般的风格都是： 262 | 263 | ``` 264 | clean: 265 | rm edit $(objects) 266 | ``` 267 | 268 | 更为稳健的做法是： 269 | 270 | ``` 271 | .PHONY : clean 272 | clean : 273 | -rm edit $(objects) 274 | ``` 275 | 276 | 前面说过， **```.PHONY``` 表示 ```clean``` 是一个“伪目标”**。而在 ```rm``` 命令前面加了一个小减号的 277 | 意思就是，也许某些文件出现问题，但不要管，继续做后面的事。 278 | 279 | 当然， ```clean``` 的规则不要放在文件的开头，不然，这就会变成make的默认目标，相信谁也不愿意这样。不成文的规矩是——“clean从来都是放在文件的最后”。 280 | 281 | 上面就是一个makefile的概貌，也是makefile的基础，下面还有很多makefile的相关细节，准备好了 282 | 吗？准备好了就来。 283 | 284 | ## Makefile里有什么？ 285 | 286 | Makefile里主要包含了五个东西：显式规则、隐晦规则、变量定义、文件指示和注释。 287 | 288 | 1. 显式规则。显式规则说明了如何生成一个或多个目标文件。这是由Makefile的书写者明显指出要生成的 289 | 文件、文件的依赖文件和生成的命令。 290 | 2. 隐晦规则。由于我们的make有自动推导的功能，所以隐晦的规则可以让我们比较简略地书写 291 | Makefile，这是由make所支持的。 292 | 3. 变量的定义。在Makefile中我们要定义一系列的变量，变量一般都是字符串，这个有点像你C语言中的 293 | 宏，当Makefile被执行时，其中的变量都会被扩展到相应的引用位置上。 294 | 4. 文件指示。其包括了三个部分，一个是在一个Makefile中引用另一个Makefile，就像C语言中 295 | 的include一样；另一个是指根据某些情况指定Makefile中的有效部分，就像C语言中的预编译#if一 296 | 样；还有就是定义一个多行的命令。有关这一部分的内容，我会在后续的部分中讲述。 297 | 5. 注释。Makefile中只有行注释，和UNIX的Shell脚本一样，其注释是用 ```#``` 字符，这个就 298 | 像C/C++中的 ```//``` 一样。如果你要在你的Makefile中使用 ```#``` 字符，可以用反斜杠进行 299 | 转义，如： ```\#``` 。 300 | 301 | 最后，还值得一提的是，在Makefile中的**命令部分**，必须要以 ```Tab``` 键开始。这点类似于Python强制tab缩进，取消了括号 302 | 303 | ## Makefile的文件名 304 | 305 | 默认的情况下，make命令会在当前目录下按顺序找寻文件名为“GNUmakefile”、 306 | “makefile”、“Makefile”的文件，找到了解释这个文件。在这三个文件名中，**最好使用“Makefile” 307 | 这个文件名，因为，这个文件名第一个字符为大写，这样有一种显目的感觉。最好不要用“GNUmakefile”， 308 | 这个文件是GNU的make识别的。有另外一些make只对全小写的“makefile”文件名敏感，但是基本上来说， 309 | 大多数的make都支持“makefile”和“Makefile”这两种默认文件名。** 310 | 311 | 当然，你可以使用别的文件名来书写Makefile，比如：“Make.Linux”，“Make.Solaris” 312 | ，“Make.AIX”等，**如果要指定特定的Makefile，你可以使用make的 ``-f`` 和 ``--file`` 参数， 313 | 如： ```make -f Make.Linux``` 或 ```make --file Make.AIX``` 。** 314 | 315 | ## 引用其它的Makefile 316 | 317 | 在Makefile使用 ```include``` 关键字可以把别的Makefile包含进来，这很像C语言的 318 | ```#include``` ，被包含的文件会原模原样的放在当前文件的包含位置。 ``include`` 的语法是： 319 | 320 | ``` 321 | include 322 | ``` 323 | 324 | ``filename`` 可以是当前操作系统Shell的文件模式（**可以包含路径和通配符**）。 325 | 326 | **在 ```include``` 前面可以有一些空字符，但是绝不能是 ```Tab``` 键开始**。 327 | 328 | ```include``` 和```` 可以用一个或多个空格隔开。举个例子，你有这样几个Makefile： ```a.mk``` 、 329 | ```b.mk``` 、 ```c.mk``` ，还有一个文件叫 ```foo.make``` ，以及一个变量 ```$(bar)``` ，这个变量定义了另外两个mk文件 ```e.mk`` 和 ```f.mk``` ，那么，下面的语句： 330 | 331 | ``` 332 | include foo.make *.mk $(bar) 333 | ``` 334 | 335 | 等价于： 336 | 337 | ``` 338 | include foo.make a.mk b.mk c.mk e.mk f.mk 339 | ``` 340 | 341 | make命令开始时，会找寻 ``include`` 所指出的其它Makefile，并把其内容**安置在当前的位置，原封不动添加到include的位置**。就好像C/C++的 ``#include`` 指令一样。如果文件都没有指定绝对路径或是相对路径的话，make会在当前目 342 | 录下首先寻找，如果当前目录下没有找到，那么，make还会在下面的几个目录下找： 343 | 344 | #. 如果make执行时，有 ``-I`` 或 ``--include-dir`` 参数，那么make就会在这个参数所指定的目 345 | 录下去寻找。 346 | #. 如果目录 ``/include`` （一般是： ``/usr/local/bin`` 或 347 | ``/usr/include`` ）存在的话，make也会去找。 348 | 349 | **如果有文件没有找到的话，make会生成一条警告信息，但不会马上出现致命错误，也就是说include不存在的文件，不会立即退出。**。它会继续载入其它的文件，一旦完成makefile的读取，make会再重试这些没有找到，或是不能读取的文件，如果还是 350 | 不行，make才会出现一条致命信息。如果你想让make不理那些无法读取的文件，而继续执行，你可以 351 | 在include前加一个减号“-”。如： 352 | 353 | ``` 354 | -include 355 | ``` 356 | 357 | **其表示，无论include过程中出现什么错误，都不要报错继续执行。和其它版本make兼容的相关命令是sinclude，其作用和这一个是一样的。** 358 | 359 | ## 环境变量MAKEFILES 360 | 361 | **不推荐使用该变量** 362 | 363 | 如果你的当前环境中定义了环境变量 ```MAKEFILES``` ，那么，make会把这个变量中的值做一个类似于 364 | ```include``` 的动作。这个变量中的值是其它的Makefile，用空格分隔。只是，它和 ``include`` 不同的是： 365 | 366 | 1. 从这个环境变量中引入的Makefile的“目标”不会起作用， 367 | 2. 如果环境变量中定义的文件发现错误，make也会不理。 368 | 369 | 但是在这里我还是建议不要使用这个环境变量，因为只要这个变量一被定义，那么当你使用make时， 370 | 所有的Makefile都会受到它的影响，这绝不是你想看到的。在这里提这个事，只是为了告诉大家，也许 371 | 有时候你的Makefile出现了怪事，那么你可以看看当前环境中有没有定义这个变量。 372 | 373 | ## make的工作方式 374 | 375 | GNU的make工作时的执行步骤如下：（想来其它的make也是类似） 376 | 377 | 1. 读入所有的Makefile。 378 | 2. 读入被include的其它Makefile。 379 | 3. 初始化文件中的变量。 380 | 4. 推导隐晦规则，并分析所有规则。 381 | 5. 为所有的目标文件创建依赖关系链。 382 | 6. 根据依赖关系，决定哪些目标要重新生成。 383 | 7. 执行生成命令。 384 | 385 | 1-5步为第一个阶段，6-7为第二个阶段。第一个阶段中，如果定义的变量被使用了，那么，make会把其展 386 | 开在使用的位置。但make并不会完全马上展开，make使用的是拖延战术，如果变量出现在依赖关系的规则 387 | 中，那么仅当这条依赖被决定要使用了，变量才会在其内部展开。 388 | 389 | 当然，这个工作方式你不一定要清楚，但是知道这个方式你也会对make更为熟悉。有了这个基础，后续部分 390 | 也就容易看懂了。 391 | -------------------------------------------------------------------------------- /docs/make概述.md: -------------------------------------------------------------------------------- 1 | # 概述 2 | 3 | 什么是makefile？或许很多Windows的程序员都不知道这个东西，因为那些Windows的集成开发环境 **（integrated development environment，IDE）**都为你做了这个工作，但我觉得要作一个好的和专 业的程序员，makefile还是要懂。这就好像现在有这么多的HTML编辑器，但如果你想成为一个专业人士，你还是要了解HTML的标签的含义。特别在Unix下的软件编译，你就不能不自己写makefile了，会不会写makefile，从一个侧面说明了一个人是否具备完成大型工程的能力。 4 | 5 | 因为，makefile关系到了整个工程的编译规则。一个工程中的源文件不计其数，并且按类型、功能、模块分别放在若干个目录中，makefile定义了一系列的规则来指定，哪些文件需要先编译，哪些文件需要后编译， 哪些文件需要重新编译，甚至于进行更复杂的功能操作，因为makefile就像一个Shell脚本一样，其中也可以执行操作系统的命令。 6 | 7 | makefile带来的好处就是——“**自动化编译**”，一旦写好，只需要一个make命令，整个工程完全自动编译，极大的提高了软件开发的效率。 make是一个命令工具，是一个解释makefile中指令的命令工具，一般来说， 大多数的IDE都有这个命令，比如：Delphi的make，Visual C++的nmake，Linux下GNU的make。可见 ，makefile都成为了一种在工程方面的编译方法。 8 | 9 | 现在讲述如何写makefile的文章比较少，这是我想写这篇文章的原因。当然，不同产商的make各不相同，也有不同的语法，但其本质都是在 “文件依赖性”上做文章，这里，我仅对GNU的make进行讲述，我的环境 是RedHat Linux 8.0，make的版本是3.80。毕竟，这个make是应用最为广泛的，也是用得最多的。而且 其还是最遵循于IEEE 1003.2-1992标准的（POSIX.2）。 10 | 11 | 在这篇文档中，将以C/C++的源码作为基础，所以必然涉及一些关于C/C++的编译的知识。关于这方面的内容，还请各位查看相关的编译器的文档。这里所默认的编译器是UNIX下的GCC和CC。 12 | -------------------------------------------------------------------------------- /docs/make的运行.md: -------------------------------------------------------------------------------- 1 | # make的运行 2 | 3 | 4 | 一般来说，最简单的就是直接在命令行下输入make命令，make命令会找当前目录的makefile来执行，一切都是自动的。 5 | 但也有时你也许只想让make重编译某些文件，而不是整个工程，而又有的时候你有几套编译规则，你想在不同的时候使用不同的编译规则，等等。本章节就是讲述如何使用make命令的。 6 | 7 | ## make的退出码 8 | 9 | make命令执行后有三个退出码： 10 | 11 | * 0 表示成功执行。 12 | * 1 如果make运行时出现任何错误，其返回1。 13 | * 2 如果你使用了make的“-q”选项，并且make使得一些目标不需要更新，那么返回2。 14 | 15 | Make的相关参数我们会在后续章节中讲述。 16 | 17 | ## 指定Makefile 18 | 19 | **GNUmakefile -> makefile -> Makefile** 20 | 21 | 前面我们说过，GNU make找寻默认的Makefile的规则是在当前目录下依次找三个文件——“GNUmakefile” 22 | 、“makefile”和“Makefile”。其按顺序找这三个文件，一旦找到，就开始读取这个文件并执行。 23 | 24 | 当前，我们也可以给make命令指定一个特殊名字的Makefile。要达到这个功能，我们要使用make的 25 | ```-f``` 或是 ```--file``` 参数（ ```--makefile``` 参数也行）。例 26 | 27 | 如，我们有个makefile的名字是“hchen.mk”，那么，我们可以这样来让make来执行这个文件： 28 | 29 | ``` 30 | make –f hchen.mk 31 | ``` 32 | 33 | 多次使用-f参数：如果在make的命令行是，你不只一次地使用了 ```-f``` 参数，那么，所有指定的makefile将会被连在 34 | 一起传递给make执行。 35 | 36 | ## 指定目标 37 | 38 | * 一般来说，make的最终目标是makefile中的第一个目标，而其它目标一般是由这个目标连带出来的。这是make的默认行为。 39 | * 一般来说，你的makefile中的第一个目标是由许多个目标组成，你可以指示make，让其完成你所指定的目标。要达到这一目的很简单，需在make命令后直接跟目标的名字就可以完成 40 | （如前面提到的“make clean”形式） 41 | 42 | **任何在makefile中的目标都可以被指定成终极目标，但是除了以 ```-``` 打头，或是包含了 ```=``` 的目标，因为有这些字符的目标，会被解析成命令行参数或是变量。** 43 | 44 | **甚至没有被我们明确写出来的目标也可以成为make的终极目标，也就是说，只要make可以找到其隐含规则推导规则，那么这个隐含目标同样可以被指定成终极目标。** 45 | 46 | 有一个make的环境变量叫 ```MAKECMDGOALS``` ，这个变量中会存放你所指定的终极目标的列表，如果在命令行上，你没有指定目标，那么，这个变量是空值。这个变量可以让你使用在一些比较特殊的情形下。比如下面的例子： 47 | 48 | ``` 49 | sources = foo.c bar.c 50 | ifneq ( $(MAKECMDGOALS),clean) 51 | include $(sources:.c=.d) 52 | endif 53 | ``` 54 | 55 | 基于上面的这个例子，只要我们输入的命令不是“make clean”，那么makefile会自动包含“foo.d”和“bar.d”这两个makefile。 56 | 57 | 使用指定终极目标的方法可以很方便地让我们编译我们的程序，例如下面这个例子： 58 | 59 | ``` 60 | .PHONY: all 61 | all: prog1 prog2 prog3 prog4 62 | ``` 63 | 64 | 从这个例子中，我们可以看到，这个makefile中有四个需要编译的程序——“prog1”， “prog2”， 65 | “prog3”和 “prog4”，我们可以使用“make all”命令来编译所有的目标（如果把all置成第一个目标，那么只需执行“make”），我们也可以使用 “make prog2”来单独编译目标“prog2”。 66 | 67 | 即然make可以指定所有makefile中的目标，那么也包括“伪目标”，于是我们可以根据这种性质来让我们的makefile根据指定的不同的目标来完成不同的事。 68 | 69 | 在Unix世界中，软件发布时，特别是GNU这种开源软件的发布时，其makefile都包含了编译、安装、打包等功能。我们可以参照这种规则来书写我们 70 | 的makefile中的目标。 71 | 72 | - all:这个伪目标是所有目标的目标，其功能一般是编译所有的目标。 73 | - clean:这个伪目标功能是删除所有被make创建的文件。 74 | - install:这个伪目标功能是安装已编译好的程序，其实就是把目标执行文件拷贝到指定的目标中去。 75 | - print:这个伪目标的功能是例出改变过的源文件。 76 | - tar:这个伪目标功能是把源程序打包备份。也就是一个tar文件。 77 | - dist:这个伪目标功能是创建一个压缩文件，一般是把tar文件压成Z文件。或是gz文件。 78 | - TAGS:这个伪目标功能是更新所有的目标，以备完整地重编译使用。 79 | - check和test:这两个伪目标一般用来测试makefile的流程。 80 | 81 | 当然一个项目的makefile中也不一定要书写这样的目标，这些东西都是GNU的东西，但是我想，GNU搞出这 82 | 些东西一定有其可取之处（等你的 UNIX下的程序文件一多时你就会发现这些功能很有用了），这里只不过 83 | 是说明了，如果你要书写这种功能，最好使用这种名字命名你的目标，这样规范一些，规范的好处就是——不 84 | 用解释，大家都明白。而且如果你的makefile中有这些功能，一是很实用，二是可以显得你的makefile很 85 | 专业（不是那种初学者的作品）。 86 | 87 | ## 检查规则 88 | 89 | 有时候，我们不想让我们的makefile中的规则执行起来，我们只想检查一下我们的命令，或是执行的序列。 90 | 于是我们可以使用make命令的下述参数： 91 | 92 | 1. ```-n```, ```--just-print```, ```--dry-run```, ```--recon``` 93 | * 不执行参数，这些参数只是打印命令，不管目标是否更新，把规则和连带规则下的命令打印出来，但不 94 | 执行，这些参数对于我们调试makefile很有用处。 95 | 96 | 2. ```-t```, ```--touch``` 97 | * 这个参数的意思就是把目标文件的时间更新，但不更改目标文件。也就是说，make假装编译目标，但不 98 | 是真正的编译目标，只是把目标变成已编译过的状态。 99 | 100 | 3. ```-q```, ```--question``` 101 | * 这个参数的行为是找目标的意思，也就是说，如果目标存在，那么其什么也不会输出，当然也不会执行 102 | 编译，如果目标不存在，其会打印出一条出错信息。 103 | 104 | 4. ```-W ```, ```--what-if=```, ```--assume-new=```, ```--new-file=``` 105 | * 这个参数需要指定一个文件。一般是是源文件（或依赖文件），Make会根据规则推导来运行依赖于这个 106 | 文件的命令，一般来说，可以和“-n”参数一同使用，来查看这个依赖文件所发生的规则命令。 107 | 108 | 另外一个很有意思的用法是结合 ```-p``` 和 ```-v``` 来输出makefile被执行时的信息（这个将在后面讲述）。 109 | 110 | ## make的参数 111 | 112 | 下面列举了所有GNU make 3.80版的参数定义。其它版本和产商的make大同小异，不过其它产商的make的具体参数还是请参考各自的产品文档。 113 | 114 | 1. ```-b```, ```-m``` 115 | * 这两个参数的作用是忽略和其它版本make的兼容性。 116 | 117 | 2. ```-B```, ```--always-make``` 118 | * 认为所有的目标都需要更新（重编译）。 119 | 120 | 3. ```-C``` **, ```--directory```\ =\ ** 121 | * 指定读取makefile的目录。如果有多个“-C”参数，make的解释是后面的路径以前面的作为相对路径 122 | ，并以最后的目录作为被指定目录。如：“make -C ~hchen/test -C prog”等价于 123 | “make -C ~hchen/test/prog”。 124 | 125 | 4. ```-debug```\ [=\ **] 126 | * 输出make的调试信息。它有几种不同的级别可供选择，如果没有参数，那就是输出最简单的调试信息。 127 | 128 | 下面是的取值： 129 | 130 | - a: 也就是all，输出所有的调试信息。（会非常的多） 131 | - b: 也就是basic，只输出简单的调试信息。即输出不需要重编译的目标。 132 | - v: 也就是verbose，在b选项的级别之上。输出的信息包括哪个makefile被解析，不需要被重编 133 | 译的依赖文件（或是依赖目标）等。 134 | - i: 也就是implicit，输出所以的隐含规则。 135 | - j: 也就是jobs，输出执行规则中命令的详细信息，如命令的PID、返回码等。 136 | - m: 也就是makefile，输出make读取makefile，更新makefile，执行makefile的信息。 137 | 138 | 1. ```-d``` 139 | * 相当于“--debug=a”。 140 | 141 | 2. ```-e```, ```--environment-overrides``` 142 | * 指明环境变量的值覆盖makefile中定义的变量的值。 143 | 144 | 3. ```-f```\ =\ **, ```--file```\ =\ **, ```--makefile```\ =\ ** 145 | * 指定需要执行的makefile。 146 | 147 | 4. ```-h```, ```--help``` 148 | * 显示帮助信息。 149 | 150 | 5. ```-i``` , ```--ignore-errors``` 151 | * 在执行时忽略所有的错误。 152 | 153 | 6. ```-I``` **, ```--include-dir```\ =\ ** 154 | * 指定一个被包含makefile的搜索目标。可以使用多个“-I”参数来指定多个目录。 155 | 156 | 7. ```-j``` [**], ```--jobs```\ [=\ **] 157 | * 指同时运行命令的个数。如果没有这个参数，make运行命令时能运行多少就运行多少。如果有一个以上的“-j”参数，那么仅最后一个“-j”才是有效的。（注意这个参数在MS-DOS中是无用的） 158 | 159 | 8. ```-k```, ```--keep-going``` 160 | * 出错也不停止运行。如果生成一个目标失败了，那么依赖于其上的目标就不会被执行了。 161 | 162 | 9. ```-l``` **, ```--load-average```\ [=\ **], ```-max-load```\ [=\ **] 163 | * 指定make运行命令的负载。 164 | 165 | 10. ```-n```, ```--just-print```, ```--dry-run```, ```--recon``` 166 | * 仅输出执行过程中的命令序列，但并不执行。 167 | 168 | 11. ```-o``` **, ```--old-file```\ =\ **, ```--assume-old```\ =\ ** 169 | * 不重新生成的指定的，即使这个目标的依赖文件新于它。 170 | 171 | 12. ```-p```, ```--print-data-base``` 172 | * 输出makefile中的所有数据，包括所有的规则和变量。这个参数会让一个简单的makefile都会输出 173 | 一堆信息。如果你只是想输出信息而不想执行makefile，你可以使用“make -qp”命令。如果你想查 174 | 看执行makefile前的预设变量和规则，你可以使用 “make –p –f /dev/null”。这个参数输出的 175 | 信息会包含着你的makefile文件的文件名和行号，所以，用这个参数来调试你的 makefile会是很有 176 | 用的，特别是当你的环境变量很复杂的时候。 177 | 178 | 13. ```-q```, ```--question``` 179 | * 不运行命令，也不输出。仅仅是检查所指定的目标是否需要更新。如果是0则说明要更新，如果是2则说 180 | 明有错误发生。 181 | 182 | 14. ```-r```, ```--no-builtin-rules``` 183 | * 禁止make使用任何隐含规则。 184 | 185 | 15. ```-R```, ```--no-builtin-variabes``` 186 | * 禁止make使用任何作用于变量上的隐含规则。 187 | 188 | 16. ```-s```, ```--silent```, ```--quiet``` 189 | * 在命令运行时不输出命令的输出。 190 | 191 | 17. ```-S```, ```--no-keep-going```, ```--stop``` 192 | * 取消“-k”选项的作用。因为有些时候，make的选项是从环境变量“MAKEFLAGS”中继承下来的。所以你 193 | 可以在命令行中使用这个参数来让环境变量中的“-k”选项失效。 194 | 195 | 18. ```-t```, ```--touch``` 196 | * 相当于UNIX的touch命令，只是把目标的修改日期变成最新的，也就是阻止生成目标的命令运行。 197 | 198 | 19. ```-v```, ```--version``` 199 | * 输出make程序的版本、版权等关于make的信息。 200 | 201 | 20. ```-w```, ```--print-directory``` 202 | * 输出运行makefile之前和之后的信息。这个参数对于跟踪嵌套式调用make时很有用。 203 | 204 | 21. ```--no-print-directory``` 205 | * 禁止“-w”选项。 206 | 207 | 22. ```-W``` **, ```--what-if```\ =\ **, ```--new-file```\ =\ **, ```--assume-file```\ =\ ** 208 | * 假定目标;需要更新，如果和“-n”选项使用，那么这个参数会输出该目标更新时的运行动作。 209 | 如果没有“-n”那么就像运行UNIX的“touch”命令一样，使得;的修改时间为当前时间。 210 | 211 | 23. ```--warn-undefined-variables``` 212 | * 只要make发现有未定义的变量，那么就输出警告信息。 213 | -------------------------------------------------------------------------------- /docs/书写命令.md: -------------------------------------------------------------------------------- 1 | # 书写命令 2 | 3 | 1. 每条规则中的命令和操作系统Shell的命令行是一致的。 4 | 2. make会一按顺序一条一条的执行命令，每条命令的开头必须以 ``Tab`` 键开头，除非，命令是紧跟在依赖规则后面的分号后的。 5 | 3. 在命令行之间中的空格或是空行会被忽略，但是如果该空格或空行是以Tab键开头的，那么make会认为其是一个空命令。 6 | 7 | 我们在UNIX下可能会使用不同的Shell，但是make的命令默认是被 ``/bin/sh`` ——UNIX的标准Shell 8 | 解释执行的。除非你特别指定一个其它的Shell。 9 | 10 | Makefile中， ``#`` 是注释符，很像C/C++中的``//`` ，其后的本行字符都被注释。 11 | 12 | ## 显示命令 13 | 14 | 通常，**make会把其要执行的命令行在命令执行前输出到屏幕上。当我们用 ``@`` 字符在命令行前，那么， 15 | 这个命令将不被make显示出来**，最具代表性的例子是，我们用这个功能来向屏幕显示一些信息。如:: 16 | ``` 17 | @echo 正在编译XXX模块...... 18 | ``` 19 | 当make执行时，会输出“正在编译XXX模块......”字串，但不会输出命令，如果没有“@”，那么，make将 20 | 输出:: 21 | ``` 22 | echo 正在编译XXX模块...... 23 | 正在编译XXX模块...... 24 | ``` 25 | **如果make执行时，带入make参数 ```-n``` 或 ```--just-print``` ，那么其只是显示命令，但不会执行 26 | 命令，这个功能很有利于我们调试我们的Makefile，看看我们书写的命令是执行起来是什么样子的或是什么 27 | 顺序的。** 28 | 29 | 而make参数 ```-s``` 或 ```--silent``` 或 ```--quiet``` 则是全面禁止命令的显示。 30 | 31 | ## 命令执行 32 | 33 | 当依赖目标新于目标时，也就是当规则的目标需要被更新时，make会一条一条的执行其后的命令。**需要注意 34 | 的是，如果你要让上一条命令的结果应用在下一条命令时，你应该使用分号分隔这两条命令。比如你的第一 35 | 条命令是cd命令，你希望第二条命令得在cd之后的基础上运行，那么你就不能把这两条命令写在两行上，而 36 | 应该把这两条命令写在一行上，用分号分隔。**如： 37 | 38 | - 示例一： 39 | 40 | ``` 41 | exec: 42 | cd /home/hchen 43 | pwd 44 | ``` 45 | - 示例二： 46 | 47 | ``` 48 | exec: 49 | cd /home/hchen; pwd 50 | ``` 51 | 52 | 当我们执行 ```make exec``` 时，第一个例子中的cd没有作用，pwd会打印出当前的Makefile目录，而第 53 | 二个例子中，cd就起作用了，pwd会打印出“/home/hchen”。 54 | 55 | make一般是使用环境变量SHELL中所定义的系统Shell来执行命令，默认情况下使用UNIX的标 56 | 准Shell——/bin/sh来执行命令。但在MS-DOS下有点特殊，因为MS-DOS下没有SHELL环境变量，当然你也 57 | 可以指定。如果你指定了UNIX风格的目录形式，首先，make会在SHELL所指定的路径中找寻命令解释器，如 58 | 果找不到，其会在当前盘符中的当前目录中寻找，如果再找不到，其会在PATH环境变量中所定义的所有路径 59 | 中寻找。MS-DOS中，如果你定义的命令解释器没有找到，其会给你的命令解释器加上诸如 ``.exe`` 、 60 | ``.com`` 、 ``.bat`` 、 ``.sh`` 等后缀。 61 | 62 | ## 命令出错 63 | 64 | 每当命令运行完后，make会检测每个命令的返回码，如果命令返回成功，那么make会执行下一条命令，当规 65 | 则中所有的命令成功返回后，这个规则就算是成功完成了。 66 | 67 | **如果一个规则中的某个命令出错了（命令退出码非零），那么make就会终止执行当前规则，这将有可能终止所有规则的执行。** 68 | 69 | 有些时候，命令的出错并不表示就是错误的。例如mkdir命令，我们一定需要建立一个目录，如果目录不存 70 | 在，那么mkdir就成功执行，万事大吉，如果目录存在，那么就出错了。我们之所以使用mkdir的意思就是 71 | 一定要有这样的一个目录，于是我们就不希望mkdir出错而终止规则的运行。 72 | 73 | 为了做到这一点，忽略命令的出错，**我们可以在Makefile的命令行前加一个减号 ``-`` （在Tab键之后） 74 | ，标记为不管命令出不出错都认为是成功的。**如： 75 | 76 | ``` 77 | clean: 78 | -rm -f *.o 79 | ``` 80 | **还有一个全局的办法是，给make加上 ``-i`` 或是 ``--ignore-errors`` 参数**，那么，Makefile中 81 | 所有命令都会忽略错误。**而如果一个规则是以 ``.IGNORE`` 作为目标的，那么这个规则中的所有命令将会 82 | 忽略错误。这些是不同级别的防止命令出错的方法，你可以根据你的不同喜欢设置。** 83 | 84 | 还有一个要提一下的**make的参数的是 ``-k`` 或是 ``--keep-going`` ，这个参数的意思是，如果某 85 | 规则中的命令出错了，那么就终止该规则的执行，但继续执行其它规则。** 86 | 87 | ## 嵌套执行make 88 | 89 | 在一些大的工程中，我们会把我们不同模块或是不同功能的源文件放在不同的目录中，我们可以在每个目录 90 | 中都书写一个该目录的Makefile，这有利于让我们的Makefile变得更加地简洁，而不至于把所有的东西全 91 | 部写在一个Makefile中，这样会很难维护我们的Makefile，这个技术对于我们模块编译和分段编译有着非 92 | 常大的好处。 93 | 94 | 例如，我们有一个子目录叫subdir，这个目录下有个Makefile文件，来指明了这个目录下文件的编译规则 95 | 。那么我们总控的Makefile可以这样书写： 96 | 97 | ``` 98 | subsystem: 99 | cd subdir && $(MAKE) 100 | ``` 101 | 其等价于： 102 | 103 | ``` 104 | subsystem: 105 | $(MAKE) -C subdir 106 | ``` 107 | 定义$(MAKE)宏变量的意思是，也许我们的make需要一些参数，所以定义成一个变量比较利于维护。这两个 108 | 例子的意思都是先进入“subdir”目录，然后执行make命令。 109 | 110 | 我们把这个Makefile叫做“**总控Makefile**”，**总控Makefile的变量可以传递到下级的Makefile中（如果 111 | 你显示的声明），但是不会覆盖下层的Makefile中所定义的变量，除非指定了 ``-e`` 参数。** 112 | 113 | 如果你要传递变量到下级Makefile中，那么你可以使用这样的声明:: 114 | ``` 115 | export ; 116 | ``` 117 | 如果你不想让某些变量传递到下级Makefile中，那么你可以这样声明:: 118 | ``` 119 | unexport ; 120 | ``` 121 | 如： 122 | 123 | 示例一： 124 | 125 | ``` 126 | export variable = value 127 | ``` 128 | 其等价于： 129 | 130 | ``` 131 | variable = value 132 | export variable 133 | ``` 134 | 其等价于： 135 | 136 | ``` 137 | export variable := value 138 | ``` 139 | 其等价于： 140 | 141 | ``` 142 | variable := value 143 | export variable 144 | ``` 145 | 示例二： 146 | 147 | ``` 148 | export variable += value 149 | ``` 150 | 其等价于： 151 | 152 | ``` 153 | variable += value 154 | export variable 155 | ``` 156 | 如果你要传递所有的变量，那么，只要一个export就行了。后面什么也不用跟，表示传递所有的变量。 157 | 158 | 需要注意的是，**有两个变量，一个是 ``SHELL`` ，一个是 ``MAKEFLAGS`` ，这两个变量不管你是 159 | 否export，其总是要传递到下层 Makefile中，特别是 ``MAKEFLAGS`` 变量，其中包含了make的参数 160 | 信息，如果我们执行“总控Makefile”时有make参数或是在上层 Makefile中定义了这个变量，那么 161 | ``MAKEFLAGS`` 变量将会是这些参数，并会传递到下层Makefile中，这是一个系统级的环境变量。** 162 | 163 | 但是make命令中的有几个参数并不往下传递，它们是 ```-C``` , ```-f``` , ```-h```, ```-o``` 和 164 | ```-W``` （有关Makefile参数的细节将在后面说明），如果你不想往下层传递参数，那么，你可以这样来： 165 | 166 | ``` 167 | subsystem: 168 | cd subdir && $(MAKE) MAKEFLAGS= 169 | ``` 170 | 171 | 如果你定义了环境变量 ``MAKEFLAGS`` ，那么你得确信其中的选项是大家都会用到的，如果其中有 172 | ``-t`` , ``-n`` 和 ``-q`` 参数，那么将会有让你意想不到的结果，或许会让你异常地恐慌。 173 | 174 | 还有一个在“嵌套执行”中比较有用的参数， ``-w`` 或是 ``--print-directory`` 会在make的过程 175 | 中输出一些信息，让你看到目前的工作目录。比如，如果我们的下级make目录 176 | 是“/home/hchen/gnu/make”，如果我们使用 ``make -w`` 来执行，那么当进入该目录时，我们会看 177 | 到:: 178 | 179 | make: Entering directory `/home/hchen/gnu/make'. 180 | 181 | 而在完成下层make后离开目录时，我们会看到:: 182 | 183 | make: Leaving directory `/home/hchen/gnu/make' 184 | 185 | 当你使用 ``-C`` 参数来指定make下层Makefile时， ``-w`` 会被自动打开的。如果参数中有 186 | ``-s`` （ ``--slient`` ）或是 ``--no-print-directory`` ，那么， ``-w`` 总是失效的。 187 | 188 | ## 定义命令包 189 | 190 | 如果Makefile中出现一些相同命令序列，那么我们可以为这些相同的命令序列定义一个变量。定义这种命令 191 | 序列的语法以 ``define`` 开始，以 ``endef`` 结束，如:: 192 | ``` 193 | define run-yacc 194 | yacc $(firstword $^) 195 | mv y.tab.c $@ 196 | endef 197 | ``` 198 | 这里，“run-yacc”是这个命令包的名字，其不要和Makefile中的变量重名。在 ``define`` 和 199 | ``endef`` 中的两行就是命令序列。这个命令包中的第一个命令是运行Yacc程序，因为Yacc程序总是生 200 | 成“y.tab.c”的文件，所以第二行的命令就是把这个文件改改名字。还是把这个命令包放到一个示例中来看 201 | 看吧。 202 | 203 | ``` 204 | foo.c : foo.y 205 | $(run-yacc) 206 | ``` 207 | 208 | 我们可以看见，要使用这个命令包，我们就好像使用变量一样。在这个命令包的使用中，命令 209 | 包“run-yacc”中的 ``$^`` 就是 ``foo.y`` ， ``$@`` 就是 ``foo.c`` （有关这种以 ``$`` 210 | 开头的特殊变量，我们会在后面介绍），make在执行命令包时，命令包中的每个命令会被依次独立执行。 211 | -------------------------------------------------------------------------------- /docs/书写规则.md: -------------------------------------------------------------------------------- 1 | # 书写规则 2 | 3 | **规则包含两个部分，一个是依赖关系，一个是生成目标的方法。** 4 | 5 | * 在Makefile中，规则的顺序是很重要的，因为，Makefile中只应该有一个最终目标，其它的目标都是被这个目标所连带出来的，所以一定要让make知道你的最终目标是什么。 6 | * 一般来说，定义在Makefile中的目标可能会有很多，但是第一条规则中的目标将被确立为最终的目标。如果第一条规则中的目标有很多个，那么，第一个目标会成为最终的目标。make所完成的也就是这个目标。 7 | 8 | 好了，还是让我们来看一看如何书写规则。 9 | 10 | ## 规则举例 11 | 12 | ``` 13 | foo.o: foo.c defs.h # foo模块 14 | cc -c -g foo.c 15 | ``` 16 | 17 | 看到这个例子，各位应该不是很陌生了，前面也已说过， ```foo.o``` 是我们的目标， ```foo.c``` 和 18 | ```defs.h``` 是目标所依赖的源文件，而只有一个命令 ```cc -c -g foo.c``` （以Tab键开头）。这个 19 | 规则告诉我们两件事： 20 | 21 | 1. 文件的依赖关系， ``foo.o`` 依赖于 ``foo.c`` 和 ``defs.h`` 的文件，如果 ``foo.c`` 22 | 和 ``defs.h`` 的文件日期要比 ``foo.o`` 文件日期要新，或是 ``foo.o`` 不存在，那么依赖 23 | 关系发生。 24 | 2. 生成或更新 ``foo.o`` 文件，就是那个cc命令。它说明了如何生成 ``foo.o`` 这个文件。 25 | （当然，foo.c文件include了defs.h文件） 26 | 27 | ## 规则的语法 28 | 29 | ``` 30 | targets : prerequisites 31 | command 32 | ... 33 | ``` 34 | 或是这样： 35 | 36 | ``` 37 | targets : prerequisites ; command 38 | command 39 | ... 40 | ``` 41 | 42 | targets是文件名，以空格分开，可以使用通配符。 43 | **一般来说，我们的目标基本上是一个文件，但也有可能是多个文件。** 44 | 45 | command是命令行，如果其不与“target:prerequisites”在一行，那么，**必须以 ``Tab`` 键开头，如 46 | 果和prerequisites在一行，那么可以用分号做为分隔。（见上）** 47 | 48 | prerequisites也就是目标所依赖的文件（或依赖目标）。如果其中的某个文件要比目标文件要新，那么， 49 | 目标就被认为是“过时的”，被认为是需要重生成的。这个在前面已经讲过了。 50 | 51 | 如果命令太长，你可以使用反斜杠（ ``\`` ）作为换行符。**make对一行上有多少个字符没有限制。 52 | 规则告诉make两件事，文件的依赖关系和如何生成目标文件。** 53 | 54 | **一般来说，make会以UNIX的标准Shell，也就是 ``/bin/sh`` 来执行命令。** 55 | 56 | ## 在规则中使用通配符 57 | 58 | 如果我们想定义一系列比较类似的文件，我们很自然地就想起使用通配符。make支持三个通配符： 59 | ```*``` ， ```?``` 和 ```~``` 。这是和Unix的B-Shell是相同的。 60 | 61 | 波浪号（ ``~`` ）字符在文件名中也有比较特殊的用途。如果是 ``~/test`` ，这就表示当前用户 62 | 的 ``$HOME`` 目录下的test目录。而 ``~hchen/test`` 则表示用户hchen的宿主目录下的test 63 | 目录。（这些都是Unix下的小知识了，make也支持）而在Windows或是 MS-DOS下，用户没有宿主目录， 64 | 那么波浪号所指的目录则根据环境变量“HOME”而定。 65 | 66 | 通配符代替了你一系列的文件，如 ``*.c`` 表示所有后缀为c的文件。一个需要我们注意的是，如果我们 67 | 的文件名中有通配符，如： ``*`` ，那么可以用转义字符 ``\`` ，如 ``\*`` 来表示真实的 ``*`` 68 | 字符，而不是任意长度的字符串。 69 | 70 | 好吧，还是先来看几个例子吧： 71 | 72 | ``` 73 | clean: 74 | rm -f *.o 75 | ``` 76 | 77 | 其实在这个clean:后面可以加上你想做的一些事情，如果你想看到在编译完后看看main.c的源代码，你 78 | 可以在加上cat这个命令，例子如下： 79 | 80 | ``` 81 | clean: 82 | cat main.c 83 | rm -f *.o 84 | ``` 85 | 86 | 其结果你试一下就知道的。 上面这个例子我不不多说了，这是操作系统Shell所支持的通配符。这是在命令 87 | 中的通配符。 88 | 89 | ``` 90 | print: *.c 91 | lpr -p $? 92 | touch print 93 | ``` 94 | 95 | 上面这个例子说明了通配符也可以在我们的规则中，目标print依赖于所有的 ``.c`` 文件。其中的 96 | ``$?`` 是一个**自动化变量**，我会在后面给你讲述。 97 | 98 | ``` 99 | objects = *.o 100 | ``` 101 | 102 | **上面这个例子，表示了通配符同样可以用在变量中。并不是说 ``*.o`` 会展开，不！objects的值就是 103 | ``*.o`` 。Makefile中的变量其实就是C/C++中的宏。**如果你要让通配符在变量中展开，也就是 104 | 让objects的值是所有 ``.o`` 的文件名的集合，那么，你可以这样： 105 | 106 | ``` 107 | objects := $(wildcard *.o) 108 | ``` 109 | 110 | 另给一个变量使用通配符的例子： 111 | 112 | 1. 列出一确定文件夹中的所有 ``.c`` 文件。 113 | 114 | ``` 115 | objects := $(wildcard *.c) 116 | ``` 117 | 2. 列出(1)中所有文件对应的 ``.o`` 文件，在（3）中我们可以看到它是由make自动编译出的:: 118 | ``` 119 | $(patsubst %.c,%.o,$(wildcard *.c)) 120 | ``` 121 | 3. 由(1)(2)两步，可写出编译并链接所有 ``.c`` 和 ``.o`` 文件 122 | ``` 123 | objects := $(patsubst %.c,%.o,$(wildcard *.c)) 124 | foo : $(objects) 125 | cc -o foo $(objects) 126 | ``` 127 | 这种用法由关键字“wildcard”，“patsubst”指出，关于Makefile的关键字，我们将在后面讨论。 128 | 129 | ## 文件搜寻VPATH特殊环境变量 130 | 131 | 在一些大的工程中，有大量的源文件，我们通常的做法是把这许多的源文件分类，并存放在不同的目录中。 132 | 所以，当make需要去找寻文件的依赖关系时，你可以在文件前加上路径，但最好的方法是把一个路径告 133 | 诉make，让make在自动去找。 134 | 135 | Makefile文件中的**特殊变量 ``VPATH`` **就是完成这个功能的，如果没有指明这个变量，make只会在当前 136 | 的目录中去找寻依赖文件和目标文件。如果定义了这个变量，那么，make就会在当前目录找不到的情况下 137 | ，到所指定的目录中去找寻文件了。 138 | 139 | ``` 140 | VPATH = src:../headers 141 | ``` 142 | 143 | 上面的定义指定两个目录，“src”和“../headers”，make会按照这个顺序进行搜索。**目录由“冒号”分隔 144 | 。（当然，当前目录永远是最高优先搜索的地方）** 145 | 146 | 另一个设置文件搜索路径的方法是使用make的“vpath”关键字（注意，它是全小写的），这不是变量，这是 147 | 一个make的关键字，这和上面提到的那个VPATH变量很类似，但是它更为灵活。它可以指定不同的文件在不 148 | 同的搜索目录中。这是一个很灵活的功能。它的使用方法有三种： 149 | 150 | ```vpath ``` 151 | 为符合模式的文件指定搜索目录。 152 | 153 | ```vpath ``` 154 | 清除符合模式的文件的搜索目录。 155 | 156 | ```vpath``` 157 | 清除所有已被设置好了的文件搜索目录。 158 | 159 | **vapth使用方法中的需要包含 ```%``` 字符。 ```%``` 的意思是匹配零或若干字符，（需引用```%``` ，使用 ```\``` ）** 160 | 161 | 例如， ``%.h`` 表示所有以 ```.h``` 结尾的文件。指定了要搜索 162 | 的文件集，而则指定了< pattern>的文件集的搜索的目录。例如： 163 | 164 | ``` 165 | vpath %.h ../headers 166 | ``` 167 | 该语句表示，要求make在“../headers”目录下搜索所有以 ``.h`` 结尾的文件。（如果某文件在当前目 168 | 录没有找到的话） 169 | 170 | 我们可以连续地使用vpath语句，以指定不同搜索策略。如果连续的vpath语句中出现了相同的 171 | ，或是被重复了的，那么，make会按照vpath语句的先后顺序来执行搜索。如： 172 | 173 | ``` 174 | vpath %.c foo 175 | vpath % blish 176 | vpath %.c bar 177 | ``` 178 | 其表示 ``.c`` 结尾的文件，先在“foo”目录，然后是“blish”，最后是“bar”目录。 179 | 180 | ``` 181 | vpath %.c foo:bar 182 | vpath % blish 183 | ``` 184 | 185 | 而上面的语句则表示 ``.c`` 结尾的文件，先在“foo”目录，然后是“bar”目录，最后才是“blish”目录。 186 | 187 | ## 伪目标 188 | 189 | 最早先的一个例子中，我们提到过一个“clean”的目标，这是一个“伪目标”， 190 | 191 | ``` 192 | clean: 193 | rm *.o temp 194 | ``` 195 | 196 | 正像我们前面例子中的“clean”一样，既然我们生成了许多文件编译文件，我们也应该提供一个清除它们的“ 197 | 目标”以备完整地重编译而用。 （以“make clean”来使用该目标） 198 | 199 | 因为，我们并不生成“clean”这个文件。**“伪目标”并不是一个文件，只是一个标签，由于“伪目标”不是 200 | 文件，所以make无法生成它的依赖关系和决定它是否要执行**。我们只有通过显式地指明这个“目标”才能让其 201 | 生效。当然，“伪目标”的取名不能和文件名重名，不然其就失去了“伪目标”的意义了。 202 | 203 | 当然，为了避免和文件重名的这种情况，我们可以使用一个特殊的标记“.PHONY”来显式地指明一个目标是“ 204 | 伪目标”，向make说明，不管是否有这个文件，这个目标就是“伪目标”。 205 | 206 | ``` 207 | .PHONY : clean 208 | ``` 209 | 210 | 只要有这个声明，不管是否有“clean”文件，要运行“clean”这个目标，只有“make clean”这样。于是整 211 | 个过程可以这样写： 212 | 213 | ``` 214 | .PHONY : clean 215 | clean : 216 | rm *.o temp 217 | ``` 218 | 219 | 伪目标一般没有依赖的文件。但是，我们也可以为伪目标指定所依赖的文件。伪目标同样可以作为“默认目标”，只要将其放在第一个。一个示例就是: 220 | 221 | 如果你的Makefile需要一口气生成若干个可执行文件，但你只想简单地敲一个make完事，并且，所有的目标文件都写在一个Makefile中，那么你可以使用“伪目标”这个特性： 222 | 223 | ``` 224 | all : prog1 prog2 prog3 225 | .PHONY : all 226 | 227 | prog1 : prog1.o utils.o 228 | cc -o prog1 prog1.o utils.o 229 | 230 | prog2 : prog2.o 231 | cc -o prog2 prog2.o 232 | 233 | prog3 : prog3.o sort.o utils.o 234 | cc -o prog3 prog3.o sort.o utils.o 235 | ``` 236 | 237 | 我们知道，**Makefile中的第一个目标会被作为其默认目标**。我们声明了一个“all”的伪目标，其依赖于其它 238 | 三个目标。由于默认目标的特性是，总是被执行的，但由于“all”又是一个伪目标，伪目标只是一个标签不 239 | 会生成文件，所以不会有“all”文件产生。于是，其它三个目标的规则总是会被决议。也就达到了我们一口 240 | 气生成多个目标的目的。 ``.PHONY : all`` 声明了“all”这个目标为“伪目标”。（注：这里的显式 241 | “.PHONY : all” 不写的话一般情况也可以正确的执行，这样make可通过**隐式规则**推导出: 242 | 243 | **“all” 是一个伪目标，执行make不会生成“all”文件，而执行后面的多个目标。建议：显式写出是一个好习惯。）** 244 | 245 | 随便提一句，从上面的例子我们可以看出，目标也可以成为依赖。所以，伪目标同样也可成为依赖。看下面 246 | 的例子： 247 | 248 | ``` 249 | .PHONY : cleanall cleanobj cleandiff 250 | 251 | cleanall : cleanobj cleandiff 252 | rm program 253 | 254 | cleanobj : 255 | rm *.o 256 | 257 | cleandiff : 258 | rm *.diff 259 | ``` 260 | 261 | “make cleanall”将清除所有要被清除的文件。“cleanobj”和“cleandiff”这两个伪目标有点像“子程 262 | 序”的意思。我们可以输入“make cleanall”和“make cleanobj”和“make cleandiff”命令来达到清 263 | 除不同种类文件的目的。 264 | 265 | ## 多目标 266 | 267 | Makefile的规则中的目标可以不止一个，其支持多目标，有可能我们的多个目标同时依赖于一个文件，并且 268 | 其生成的命令大体类似。于是我们就能把其合并起来。当然，多个目标的生成规则的执行命令不是同一个， 269 | 这可能会给我们带来麻烦，不过好在我们可以使用一个自动化变量 ``$@`` （关于自动化变量，将在后面讲 270 | 述），这个变量表示着目前规则中所有的目标的集合，这样说可能很抽象，还是看一个例子吧。 271 | 272 | ``` 273 | bigoutput littleoutput : text.g 274 | generate text.g -$(subst output,,$@) > $@ 275 | ``` 276 | 上述规则等价于： 277 | 278 | ``` 279 | bigoutput : text.g 280 | generate text.g -big > bigoutput 281 | littleoutput : text.g 282 | generate text.g -little > littleoutput 283 | ``` 284 | 285 | 其中， ``-$(subst output,,$@)`` 中的 ``$`` 表示执行一个Makefile的函数，函数名为subst， 286 | 后面的为参数。关于函数，将在后面讲述。这里的这个函数是替换字符串的意思， ``$@`` 表示目标的 287 | 集合，就像一个数组， ``$@`` 依次取出目标，并执于命令。 288 | 289 | ## 静态模式 290 | 291 | 静态模式可以更加容易地定义多目标的规则，可以让我们的规则变得更加的有弹性和灵活。我们还是先来 292 | 看一下语法： 293 | 294 | ``` 295 | : : 296 | 297 | ... 298 | ``` 299 | 300 | targets定义了一系列的目标文件，可以有通配符。是目标的一个集合。 301 | 302 | target-parrtern是指明了targets的模式，也就是的目标集模式。 303 | 304 | prereq-parrterns是目标的依赖模式，它对target-parrtern形成的模式再进行一次依赖目标的定义。 305 | 306 | 这样描述这三个东西，可能还是没有说清楚，还是举个例子来说明一下吧。如果我们 307 | 的定义成 ``%.o`` ，意思是我们的;集合中都是以 ``.o`` 结尾的，而 308 | 如果我们的定义成 ``%.c`` ，意思是对所形成的目标集进 309 | 行二次定义，其计算方法是，取模式中的 ``%`` （也就是去掉了 ``.o`` 这个结 310 | 尾），并为其加上 ``.c`` 这个结尾，形成的新集合。 311 | 312 | 所以，我们的“目标模式”或是“依赖模式”中都应该有 ``%`` 这个字符，如果你的文件名中有 ``%`` 那么 313 | 你可以使用反斜杠 ``\`` 进行转义，来标明真实的 ``%`` 字符。 314 | 315 | 看一个例子： 316 | 317 | ``` 318 | objects = foo.o bar.o 319 | 320 | all: $(objects) 321 | 322 | $(objects): %.o: %.c 323 | $(CC) -c $(CFLAGS) $< -o $@ 324 | ``` 325 | 上面的例子中，指明了我们的目标从$object中获取， ``%.o`` 表明要所有以 ``.o`` 结尾的目标，也 326 | 就是 ``foo.o bar.o`` ，也就是变量 ``$object`` 集合的模式，而依赖模式 ``%.c`` 则取模式 327 | ``%.o`` 的 ``%`` ，也就是 ``foo bar`` ，并为其加下 ``.c`` 的后缀，于是，我们的依赖目标就 328 | 是 ``foo.c bar.c`` 。而命令中的 ``$<`` 和 ``$@`` 则是自动化变量， ``$<`` 表示第一个依赖文件， 329 | ``$@`` 表示目标集（也就是“foo.o bar.o”）。于是，上面的规则展开后等价于下面的规则： 330 | 331 | ``` 332 | foo.o : foo.c 333 | $(CC) -c $(CFLAGS) foo.c -o foo.o 334 | bar.o : bar.c 335 | $(CC) -c $(CFLAGS) bar.c -o bar.o 336 | ``` 337 | 338 | 试想，如果我们的 ``%.o`` 有几百个，那么我们只要用这种很简单的“静态模式规则”就可以写完一堆 339 | 规则，实在是太有效率了。“静态模式规则”的用法很灵活，如果用得好，那会是一个很强大的功能。再看一 340 | 个例子： 341 | 342 | ``` 343 | files = foo.elc bar.o lose.o 344 | 345 | $(filter %.o,$(files)): %.o: %.c 346 | $(CC) -c $(CFLAGS) $< -o $@ 347 | $(filter %.elc,$(files)): %.elc: %.el 348 | emacs -f batch-byte-compile $< 349 | ``` 350 | 351 | $(filter %.o,$(files))表示调用Makefile的filter函数，过滤“$files”集，只要其中模式 352 | 为“%.o”的内容。其它的内容，我就不用多说了吧。这个例子展示了Makefile中更大的弹性。 353 | 354 | ## 自动生成依赖性 355 | 356 | 在Makefile中，我们的依赖关系可能会需要包含一系列的头文件，比如，如果我们的main.c中有一句 357 | ``#include "defs.h"`` ，那么我们的依赖关系应该是： 358 | 359 | ``` 360 | main.o : main.c defs.h 361 | ``` 362 | 但是，如果是一个比较大型的工程，你必需清楚哪些C文件包含了哪些头文件，并且，你在加入或删除头文件 363 | 时，也需要小心地修改Makefile，这是一个很没有维护性的工作。为了避免这种繁重而又容易出错的事情， 364 | 我们可以使用C/C++编译的一个功能。 365 | 366 | **大多数的C/C++编译器都支持一个“-M”的选项，即自动找寻源文件中包含的头文件，并生成一个依赖关系。** 367 | 368 | 例如，如果我们执行下面的命令:: 369 | ``` 370 | cc -M main.c 371 | ``` 372 | 其输出是： 373 | ``` 374 | main.o : main.c defs.h 375 | ``` 376 | 于是由编译器自动生成的依赖关系，这样一来，你就不必再手动书写若干文件的依赖关系，而由编译器自动 377 | 生成了。需要提醒一句的是， 378 | 379 | **如果你使用GNU的C/C++编译器，你得用 ``-MM`` 参数，不然， ``-M``参数会把一些标准库的头文件也包含进来。** 380 | 381 | gcc -M main.c的输出是:: 382 | ``` 383 | main.o: main.c defs.h /usr/include/stdio.h /usr/include/features.h \ 384 | /usr/include/sys/cdefs.h /usr/include/gnu/stubs.h \ 385 | /usr/lib/gcc-lib/i486-suse-linux/2.95.3/include/stddef.h \ 386 | /usr/include/bits/types.h /usr/include/bits/pthreadtypes.h \ 387 | /usr/include/bits/sched.h /usr/include/libio.h \ 388 | /usr/include/_G_config.h /usr/include/wchar.h \ 389 | /usr/include/bits/wchar.h /usr/include/gconv.h \ 390 | /usr/lib/gcc-lib/i486-suse-linux/2.95.3/include/stdarg.h \ 391 | /usr/include/bits/stdio_lim.h 392 | ``` 393 | gcc -MM main.c的输出则是:: 394 | ``` 395 | main.o: main.c defs.h 396 | ``` 397 | 那么，编译器的这个功能如何与我们的Makefile联系在一起呢。因为这样一来，我们的Makefile也要根据 398 | 这些源文件重新生成，让 Makefile自已依赖于源文件？这个功能并不现实，不过我们可以有其它手段来迂 399 | 回地实现这一功能。GNU组织建议把编译器为每一个源文件的自动生成的依赖关系放到一个文件中，为每一 400 | 个 ``name.c`` 的文件都生成一个 ``name.d`` 的Makefile文件， ``.d`` 文件中就存放对应 401 | ``.c`` 文件的依赖关系。 402 | 403 | 于是，我们可以写出 ``.c`` 文件和 ``.d`` 文件的依赖关系，并让make自动更新或生成 ``.d`` 404 | 文件，并把其包含在我们的主Makefile中，这样，我们就可以自动化地生成每个文件的依赖关系了。 405 | 406 | 这里，我们给出了一个模式规则来产生 ``.d`` 文件： 407 | 408 | ``` 409 | %.d: %.c 410 | @set -e; rm -f $@; \ 411 | $(CC) -M $(CPPFLAGS) $< > $@.$$$$; \ 412 | sed 's,\($*\)\.o[ :]*,\1.o $@ : ,g' < $@.$$$$ > $@; \ 413 | rm -f $@.$$$$ 414 | ``` 415 | 这个规则的意思是，所有的 ``.d`` 文件依赖于 ``.c`` 文件， ``rm -f $@`` 的意思是删除所有的 416 | 目标，也就是 ``.d`` 文件，第二行的意思是，为每个依赖文件 ``$<`` ，也就是 ``.c`` 文件生成依 417 | 赖文件， ``$@`` 表示模式 ``%.d`` 文件，如果有一个C文件是name.c，那么 ``%`` 就是 418 | ``name`` ， ``$$$$`` 意为一个随机编号，第二行生成的文件有可能是“name.d.12345”，第三行使 419 | 用sed命令做了一个替换，关于sed命令的用法请参看相关的使用文档。第四行就是删除临时文件。 420 | 421 | 总而言之，这个模式要做的事就是在编译器生成的依赖关系中加入 ``.d`` 文件的依赖，即把依赖关系： 422 | 423 | ``` 424 | main.o : main.c defs.h 425 | ``` 426 | 转成： 427 | 428 | ``` 429 | main.o main.d : main.c defs.h 430 | ``` 431 | 432 | 于是，我们的 ``.d`` 文件也会自动更新了，并会自动生成了，当然，你还可以在这个 ``.d`` 文件中 433 | 加入的不只是依赖关系，包括生成的命令也可一并加入，让每个 ``.d`` 文件都包含一个完赖的规则。一旦 434 | 我们完成这个工作，接下来，我们就要把这些自动生成的规则放进我们的主Makefile中。我们可以使 435 | 用Makefile的“include”命令，来引入别的Makefile文件（前面讲过），例如： 436 | 437 | ``` 438 | sources = foo.c bar.c 439 | 440 | include $(sources:.c=.d) 441 | ``` 442 | 上述语句中的 ``$(sources:.c=.d)`` 中的 ``.c=.d`` 的意思是做一个替换，把变量 443 | ``$(sources)`` 所有 ``.c`` 的字串都替换成 ``.d`` ，关于这个“替换”的内容，在后面我会有更为 444 | 详细的讲述。当然，你得注意次序，因为include是按次序来载入文件，最先载入的 ``.d`` 文件中的目 445 | 标会成为默认目标。 446 | -------------------------------------------------------------------------------- /docs/使用make更新函数库文件.md: -------------------------------------------------------------------------------- 1 | # 使用make更新函数库文件 2 | 3 | 函数库文件也就是对Object文件（程序编译的中间文件）的打包文件。在Unix下，一般是由 4 | 命令 ```ar``` 来完成打包工作。 5 | 6 | ## 函数库文件的成员 7 | 8 | 一个函数库文件由多个文件组成。你可以用如下格式指定函数库文件及其组成:: 9 | ``` 10 | archive(member) 11 | ``` 12 | 这个不是一个命令，而一个目标和依赖的定义。一般来说，这种用法基本上就是为了 13 | ```ar``` 命令来服务的。如: 14 | 15 | ``` 16 | foolib(hack.o) : hack.o 17 | ar cr foolib hack.o 18 | ``` 19 | 如果要指定多个member，那就以空格分开，如:: 20 | ``` 21 | foolib(hack.o kludge.o) 22 | ``` 23 | 其等价于:: 24 | ``` 25 | foolib(hack.o) foolib(kludge.o) 26 | ``` 27 | 你还可以使用Shell的文件通配符来定义，如:: 28 | ``` 29 | foolib(*.o) 30 | ``` 31 | 32 | ## 函数库成员的隐含规则 33 | 34 | 当make搜索一个目标的隐含规则时，一个特殊的特性是，如果这个目标是 ```a(m)``` 形式 35 | 的，其会把目标变成 ```(m)``` 。 36 | 37 | 于是，如果我们的成员是 ```%.o``` 的模式定义，并且如果我们使用 ```make foo.a(bar.o)``` 的形式调用Makefile时，隐含规则会去找 ```bar.o``` 的规则， 38 | 39 | 如果没有定义 ```bar.o``` 的规则，那么内建隐含规则生效，make会去找 ```bar.c```文件来生成 ```bar.o``` ，如果找得到的话，make执行的命令大致如下: 40 | 41 | ``` 42 | cc -c bar.c -o bar.o 43 | ar r foo.a bar.o 44 | rm -f bar.o 45 | ``` 46 | 还有一个变量要注意的是 ```$%``` ，这是专属函数库文件的自动化变量，有关其说明请参见“自动化变量”一节。 47 | 48 | ## 函数库文件的后缀规则 49 | 50 | 你可以使用“后缀规则”和“隐含规则”来生成函数库打包文件，如： 51 | 52 | ``` 53 | .c.a: 54 | $(CC) $(CFLAGS) $(CPPFLAGS) -c $< -o $*.o 55 | $(AR) r $@ $*.o 56 | $(RM) $*.o 57 | ``` 58 | 59 | 其等效于： 60 | 61 | ``` 62 | (%.o) : %.c 63 | $(CC) $(CFLAGS) $(CPPFLAGS) -c $< -o $*.o 64 | $(AR) r $@ $*.o 65 | $(RM) $*.o 66 | ``` 67 | 68 | ## 注意事项 69 | 70 | 在进行函数库打包文件生成时，请小心使用make的并行机制（ ```-j``` 参数）。 71 | 72 | 如果多个```ar``` 命令在同一时间运行在同一个函数库打包文件上，就很有可以损坏这个函数库文件。 73 | 所以，在make未来的版本中，应该提供一种机制来避免并行操作发生在函数打包文件上。 74 | 75 | 但就目前而言，你还是应该不要尽量不要使用 ```-j``` 参数。 76 | 77 | --- 78 | -------------------------------------------------------------------------------- /docs/使用变量.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | - [使用变量](#使用变量) 4 | - [变量的基础](#变量的基础) 5 | - [变量中的变量](#变量中的变量) 6 | - [变量高级用法](#变量高级用法) 7 | - [追加变量值](#追加变量值) 8 | - [override 指示符](#override-指示符) 9 | - [多行变量](#多行变量) 10 | - [环境变量](#环境变量) 11 | - [目标变量](#目标变量) 12 | - [模式变量](#模式变量) 13 | 14 | 15 | # 使用变量 16 | 17 | 在Makefile中的定义的变量，就像是C/C++语言中的宏一样，他代表了一个文本字串，在Makefile中 18 | 执行的时候其会自动原模原样地展开在所使用的地方。其与C/C++所不同的是，你可以在Makefile中改变其 19 | 值。在Makefile中，变量可以使用在“目标”，“依赖目标”， “命令”或是Makefile的其它部分中。 20 | 21 | * 变量的命名字可以包含字符、数字，下划线（可以是数字开头），但不应该含有 ```:``` 、 ```#``` 、 22 | ```=``` 或是空字符（空格、回车等），不得以$开头。 23 | * 变量是大小写敏感的，“foo”、“Foo”和“FOO”是三个不同的变量名。 24 | * 传统的Makefile的变量名是全大写的命名方式，因此我也推荐全大写 25 | 26 | 有一些变量是很奇怪字串，如 ```$<``` 、 ```$@``` 等，这些是自动化变量，我会在后面介绍。 27 | 28 | ## 变量的基础 29 | 30 | 变量在声明时需要给予初值，而在使用时，需要给在变量名前加上 ``$`` 符号，但最好用小括号 31 | ```()`` 或是大括号 ``{}`` 把变量给包括起来。如果你要使用真实的 ```$``` 字符，那么你需要用 32 | ``$$`` 来表示。 33 | 34 | 变量可以使用在许多地方，如规则中的“目标”、“依赖”、“命令”以及新的变量中。先看一个例子： 35 | 36 | ``` 37 | objects = program.o foo.o utils.o 38 | program : $(objects) 39 | cc -o program $(objects) 40 | 41 | $(objects) : defs.h 42 | ``` 43 | 变量会在使用它的地方精确地展开，就像C/C++中的宏一样，例如： 44 | 45 | ``` 46 | foo = c 47 | prog.o : prog.$(foo) 48 | $(foo)$(foo) -$(foo) prog.$(foo) 49 | ``` 50 | 展开后得到： 51 | 52 | ``` 53 | prog.o : prog.c 54 | cc -c prog.c 55 | ``` 56 | 当然，千万不要在你的Makefile中这样干，这里只是举个例子来表明Makefile中的变量在使用处展开的真实样子。可见其就是一个“替代”的原理。 57 | 58 | 另外，给变量加上括号完全是为了更加安全地使用这个变量，在上面的例子中，如果你不想给变量加上括号，那也可以，但我还是**强烈建议你给变量加上括号**。 59 | 60 | ## 变量中的变量 61 | 62 | 在定义变量的值时，我们可以使用其它变量来构造变量的值，在Makefile中有两种方式来在用变量定义变量的值。 63 | 64 | 先看第一种方式，也就是简单的使用 ``=`` 号，在 ``=`` 左侧是变量，右侧是变量的值，右侧变量的值 65 | 可以定义在文件的任何一处，也就是说，右侧中的变量不一定非要是已定义好的值，其也可以使用后面定义的值。如： 66 | 67 | ``` 68 | foo = $(bar) 69 | bar = $(ugh) 70 | ugh = Huh? 71 | 72 | all: 73 | echo $(foo) 74 | ``` 75 | 我们执行“make all”将会打出变量 ``$(foo)`` 的值是 ``Huh?`` （ ``$(foo)`` 的值是``$(bar)`` ， ``$(bar)`` 的值是 ``$(ugh)`` ， ``$(ugh)`` 的值是 ``Huh?`` ）可见，变 76 | 量是可以使用后面的变量来定义的。 77 | 78 | 这个功能有好的地方，也有不好的地方，好的地方是，我们**可以把变量的真实值推到后面来定义**，如： 79 | 80 | ``` 81 | CFLAGS = $(include_dirs) -O 82 | include_dirs = -Ifoo -Ibar 83 | ``` 84 | 85 | 当 ``CFLAGS`` 在命令中被展开时，会是 ``-Ifoo -Ibar -O`` 。但这种形式也有不好的地方，那就 86 | 是递归定义，如： 87 | 88 | ``` 89 | CFLAGS = $(CFLAGS) -O 90 | ``` 91 | 或： 92 | 93 | ``` 94 | A = $(B) 95 | B = $(A) 96 | ``` 97 | 这会让make陷入无限的变量展开过程中去，当然，我们的make是有能力检测这样的定义，并会报错。还有就 98 | 是如果在变量中使用函数，那么，这种方式会让我们的make运行时非常慢，更糟糕的是，他会使用得两 99 | 个make的函数“wildcard”和“shell”发生不可预知的错误。因为你不会知道这两个函数会被调用多少次。 100 | 101 | 为了避免上面的这种方法，我们可以使用make中的另一种用变量来定义变量的方法。这种方法使用的是 ``:=`` 操作符，如： 102 | 103 | ``` 104 | x := foo 105 | y := $(x) bar 106 | x := later 107 | ``` 108 | 其等价于： 109 | 110 | ``` 111 | y := foo bar 112 | x := later 113 | ``` 114 | 值得一提的是，这种方法，**前面的变量不能使用后面的变量，只能使用前面已定义好了的变量**。如果是这样： 115 | 116 | ``` 117 | y := $(x) bar 118 | x := foo 119 | ``` 120 | 那么，y的值是“bar”，而不是“foo bar”。 121 | 122 | 上面都是一些比较简单的变量使用了，让我们来看一个复杂的例子，其中包括了make的函数、条件表达式和 123 | 一个系统变量“MAKELEVEL”的使用： 124 | 125 | ``` 126 | ifeq (0,${MAKELEVEL}) 127 | cur-dir := $(shell pwd) 128 | whoami := $(shell whoami) 129 | host-type := $(shell arch) 130 | MAKE := ${MAKE} host-type=${host-type} whoami=${whoami} 131 | endif 132 | ``` 133 | 关于条件表达式和函数，我们在后面再说，对于**系统变量“MAKELEVEL”**，其意思是，如果我们的make有一 134 | 个嵌套执行的动作（参见前面的“嵌套使用make”），那么，这个变量会记录了我们的当前Makefile的调用 135 | 层数。 136 | 137 | 下面再介绍两个定义变量时我们需要知道的，请先看一个例子，如果我们要定义一个变量，其值是一个 138 | 空格，那么我们可以这样来： 139 | 140 | ``` 141 | nullstring := 142 | space := $(nullstring) # end of the line 143 | ``` 144 | nullstring是一个Empty变量，其中什么也没有，而我们的space的值是一个空格。因为在操作符的右边 145 | 是很难描述一个空格的，这里采用的技术很管用，先用一个Empty变量来标明变量的值开始了，而后面采 146 | 用“#”注释符来表示变量定义的终止，这样，我们可以定义出其值是一个空格的变量。\ 147 | 148 | 请注意这里关于“#”的使用，注释符“#”的这种特性值得我们注意，如果我们这样定义一个变量： 149 | 150 | ``` 151 | dir := /foo/bar # directory to put the frobs in 152 | ``` 153 | 154 | dir这个变量的值是“/foo/bar”，后面还跟了4个空格，如果我们这样使用这样变量来指定别的目 155 | 录——“$(dir)/file”那么就完蛋了。 156 | 157 | 还有一个比较有用的操作符是 ```?=``` ，先看示例： 158 | 159 | ``` 160 | FOO ?= bar 161 | ``` 162 | 163 | 其含义是，如果FOO没有被定义过，那么变量FOO的值就是“bar”，如果FOO先前被定义过，那么这条语将 164 | 什么也不做，其等价于： 165 | 166 | ``` 167 | ifeq ($(origin FOO), undefined) 168 | FOO = bar 169 | endif 170 | ``` 171 | 172 | ## 变量高级用法 173 | 174 | 这里介绍两种变量的高级使用方法，第一种是变量值的替换。 175 | 176 | 我们可以替换变量中的共有的部分，其格式是 ```$(var:a=b)``` 或是 ```${var:a=b}``` ，其意思是， 177 | 把变量“var”中所有以“a”字串“结尾”的“a”替换成“b”字串。这里的“结尾”意思是“空格”或是“结束符”。 178 | 179 | 还是看一个示例吧： 180 | 181 | ``` 182 | foo := a.o b.o c.o 183 | bar := $(foo:.o=.c) 184 | ``` 185 | 这个示例中，我们先定义了一个 ```$(foo)``` 变量，而第二行的意思是把 ```$(foo)``` 中所有以 186 | ```.o``` 字串“结尾”全部替换成 ```.c``` ，所以我们的 ```$(bar)``` 的值就是“a.c b.c c.c”。 187 | 188 | 另外一种变量替换的技术是以“静态模式”（参见前面章节）定义的，如： 189 | 190 | ``` 191 | foo := a.o b.o c.o 192 | bar := $(foo:%.o=%.c) 193 | ``` 194 | 这依赖于被替换字串中的有相同的模式，模式中必须包含一个 ``%`` 字符，这个例子同样让 195 | ```$(bar)``` 变量的值为“a.c b.c c.c”。 196 | 197 | 第二种高级用法是——“把变量的值再当成变量”。先看一个例子： 198 | 199 | ``` 200 | x = y 201 | y = z 202 | a := $($(x)) 203 | ``` 204 | 在这个例子中，$(x)的值是“y”，所以$($(x))就是$(y)，于是$(a)的值就是“z”。（注意，是“x=y”， 205 | 而不是“x=$(y)”） 206 | 207 | 我们还可以使用更多的层次： 208 | 209 | ``` 210 | x = y 211 | y = z 212 | z = u 213 | a := $($($(x))) 214 | ``` 215 | 这里的 ``$(a)`` 的值是“u”，相关的推导留给读者自己去做吧。 216 | 217 | 让我们再复杂一点，使用上“在变量定义中使用变量”的第一个方式，来看一个例子： 218 | 219 | ``` 220 | x = $(y) 221 | y = z 222 | z = Hello 223 | a := $($(x)) 224 | ``` 225 | 这里的 ``$($(x))`` 被替换成了 ``$($(y))`` ，因为 ``$(y)`` 值是“z”，所以，最终结果是： 226 | ``a:=$(z)`` ，也就是“Hello”。 227 | 228 | 再复杂一点，我们再加上函数： 229 | 230 | ``` 231 | x = variable1 232 | variable2 := Hello 233 | y = $(subst 1,2,$(x)) 234 | z = y 235 | a := $($($(z))) 236 | ``` 237 | 这个例子中， ``$($($(z)))`` 扩展为 ``$($(y))`` ，而其再次被扩展为 238 | ``$($(subst 1,2,$(x)))`` 。 ``$(x)`` 的值是“variable1”，subst函数把“variable1”中的 239 | 所有“1”字串替换成“2”字串，于是，“variable1”变成 “variable2”，再取其值，所以，最终， 240 | ``$(a)`` 的值就是 ``$(variable2)`` 的值——“Hello”。（喔，好不容易） 241 | 242 | 在这种方式中，或要可以使用多个变量来组成一个变量的名字，然后再取其值： 243 | 244 | ``` 245 | first_second = Hello 246 | a = first 247 | b = second 248 | all = $($a_$b) 249 | ``` 250 | 这里的 ``$a_$b`` 组成了“first_second”，于是， ``$(all)`` 的值就是“Hello”。 251 | 252 | 再来看看结合第一种技术的例子： 253 | 254 | ``` 255 | a_objects := a.o b.o c.o 256 | 1_objects := 1.o 2.o 3.o 257 | 258 | sources := $($(a1)_objects:.o=.c) 259 | ``` 260 | 这个例子中，如果 ``$(a1)`` 的值是“a”的话，那么， ``$(sources)`` 的值就是“a.c b.c c.c”； 261 | 如果 ``$(a1)`` 的值是“1”，那么 ``$(sources)`` 的值是“1.c 2.c 3.c”。 262 | 263 | 再来看一个这种技术和“函数”与“条件语句”一同使用的例子： 264 | 265 | ``` 266 | ifdef do_sort 267 | func := sort 268 | else 269 | func := strip 270 | endif 271 | 272 | bar := a d b g q c 273 | 274 | foo := $($(func) $(bar)) 275 | ``` 276 | 这个示例中，如果定义了“do_sort”，那么： ``foo := $(sort a d b g q c)`` ，于是 277 | ``$(foo)`` 的值就是 “a b c d g q”，而如果没有定义“do_sort”，那么： 278 | ``foo := $(strip a d b g q c)`` ，调用的就是strip函数。 279 | 280 | 当然，“把变量的值再当成变量”这种技术，同样可以用在操作符的左边:: 281 | ``` 282 | dir = foo 283 | $(dir)_sources := $(wildcard $(dir)/*.c) 284 | define $(dir)_print 285 | lpr $($(dir)_sources) 286 | endef 287 | ``` 288 | 这个例子中定义了三个变量：“dir”，“foo_sources”和“foo_print”。 289 | 290 | ## 追加变量值 291 | 292 | 我们可以使用 ``+=`` 操作符给变量追加值，如： 293 | 294 | ``` 295 | objects = main.o foo.o bar.o utils.o 296 | objects += another.o 297 | ``` 298 | 299 | 于是，我们的 ``$(objects)`` 值变成：“main.o foo.o bar.o utils.o another.o”（another.o被追加进去了） 300 | 301 | 使用 ``+=`` 操作符，可以模拟为下面的这种例子： 302 | 303 | ``` 304 | objects = main.o foo.o bar.o utils.o 305 | objects := $(objects) another.o 306 | ``` 307 | 所不同的是，用 ``+=`` 更为简洁。 308 | 309 | 1. 如果变量之前没有定义过，那么， ``+=`` 会自动变成 ``=`` 310 | 2. 如果前面有变量定义，那么 ``+=`` 会继承于前次操作的赋值符。 311 | 3. 如果前一次的是 ``:=`` ，那么 ``+=`` 会以 ``:=`` 作为其赋值符 312 | 313 | 314 | ``` 315 | variable := value 316 | variable += more 317 | ``` 318 | 等价于： 319 | 320 | ``` 321 | variable := value 322 | variable := $(variable) more 323 | ``` 324 | 但如果是这种情况： 325 | 326 | ``` 327 | variable = value 328 | variable += more 329 | ``` 330 | **由于前次的赋值符是 ``=`` ，所以 ``+=`` 也会以 ``=`` 来做为赋值**，那么岂不会发生变量的递补归 331 | 定义，这是很不好的，所以make会自动为我们解决这个问题，我们不必担心这个问题。 332 | 333 | ## override 指示符 334 | 335 | 如果有变量是通常make的命令行参数设置的，那么Makefile中对这个变量的赋值会被忽略。如果你想 336 | 在Makefile中设置这类参数的值，那么，你可以使用“override”指示符。其语法是:: 337 | ``` 338 | override ; = ; 339 | 340 | override ; := ; 341 | ``` 342 | 当然，你还可以追加:: 343 | ``` 344 | override ; += ; 345 | ``` 346 | 对于多行的变量定义，我们用define指示符，在define指示符前，也同样可以使用override指示符， 347 | 如:: 348 | ``` 349 | override define foo 350 | bar 351 | endef 352 | ``` 353 | 354 | ## 多行变量 355 | 356 | 还有一种设置变量值的方法是使用define关键字。使用define关键字设置变量的值可以有换行，这有利于 357 | 定义一系列的命令（前面我们讲过“命令包”的技术就是利用这个关键字）。 358 | 359 | define指示符后面跟的是变量的名字，而重起一行定义变量的值，定义是以endef 关键字结束。其工作方 360 | 式和“=”操作符一样。变量的值可以包含函数、命令、文字，或是其它变量。因为命令需要以[Tab]键开头， 361 | 所以如果你用define定义的命令变量中没有以 ```Tab``` 键开头，那么make 就不会把其认为是命令。 362 | 363 | 下面的这个示例展示了define的用法:: 364 | ``` 365 | define two-lines 366 | echo foo 367 | echo $(bar) 368 | endef 369 | ``` 370 | 371 | ## 环境变量 372 | 373 | make运行时的系统环境变量可以在make开始运行时被载入到Makefile文件中，但是如果Makefile中已 374 | 定义了这个变量，或是这个变量由make命令行带入，那么系统的环境变量的值将被覆盖。（如果make指定 375 | 了“-e”参数，那么，系统环境变量将覆盖Makefile中定义的变量） 376 | 377 | 因此，如果我们在环境变量中设置了 ``CFLAGS`` 环境变量，那么我们就可以在所有的Makefile中使用 378 | 这个变量了。这对于我们使用统一的编译参数有比较大的好处。如果Makefile中定义了CFLAGS，那么则会 379 | 使用Makefile中的这个变量，如果没有定义则使用系统环境变量的值，一个共性和个性的统一，很像“全局 380 | 变量”和“局部变量”的特性。 381 | 382 | 当make嵌套调用时（参见前面的“嵌套调用”章节），上层Makefile中定义的变量会以系统环境变量的方式 383 | 传递到下层的Makefile 中。当然，默认情况下，只有通过命令行设置的变量会被传递。而定义在文件中的 384 | 变量，如果要向下层Makefile传递，则需要使用exprot关键字来声明。（参见前面章节） 385 | 386 | 当然，我并不推荐把许多的变量都定义在系统环境中，这样，在我们执行不用的Makefile时，拥有的是同一 387 | 套系统变量，这可能会带来更多的麻烦。 388 | 389 | ## 目标变量 390 | 391 | 前面我们所讲的在Makefile中定义的变量都是“全局变量”，在整个文件，我们都可以访问这些变量。 392 | 当然，“自动化变量”除外，如 ``$<`` 等这种类量的自动化变量就属于“规则型变量”，这种变量的值依赖 393 | 于规则的目标和依赖目标的定义。 394 | 395 | 当然，我也同样可以为某个目标设置局部变量，这种变量被称为**“Target-specific Variable”**，它可以 396 | 和“全局变量”同名，因为它的作用范围只在这条规则以及连带规则中，所以其值也只在作用范围内有效。而 397 | 不会影响规则链以外的全局变量的值。 398 | 399 | 其语法是： 400 | 401 | ``` 402 | : ; 403 | 404 | : overide 405 | ``` 406 | ;可以是前面讲过的各种赋值表达式，如 ``=`` 、 ``:=`` 、 ``+= `` 407 | 或是 ``?=`` 。第二个语法是针对于make命令行带入的变量，或是系统环境变量。 408 | 409 | 这个特性非常的有用，当我们设置了这样一个变量，这个变量会作用到由这个目标所引发的所有的规则中 410 | 去。如： 411 | 412 | ``` 413 | prog : CFLAGS = -g 414 | prog : prog.o foo.o bar.o 415 | $(CC) $(CFLAGS) prog.o foo.o bar.o 416 | 417 | prog.o : prog.c 418 | $(CC) $(CFLAGS) prog.c 419 | 420 | foo.o : foo.c 421 | $(CC) $(CFLAGS) foo.c 422 | 423 | bar.o : bar.c 424 | $(CC) $(CFLAGS) bar.c 425 | ``` 426 | 在这个示例中，不管全局的 ``$(CFLAGS)`` 的值是什么，在prog目标，以及其所引发的所有规则 427 | 中（prog.o foo.o bar.o的规则）， ``$(CFLAGS)`` 的值都是 ``-g`` 428 | 429 | ## 模式变量 430 | 431 | 在GNU的make中，还支持**模式变量（Pattern-specific Variable）**，通过上面的目标变量中，我们 432 | 知道，变量可以定义在某个目标上。模式变量的好处就是，我们可以给定一种“模式”，可以把变量定义在符 433 | 合这种模式的所有目标上。 434 | 435 | 我们知道，make的“模式”一般是至少含有一个 ```%``` 的，所以，我们可以以如下方式给所有以 ```.o``` 436 | 结尾的目标定义目标变量： 437 | 438 | ``` 439 | %.o : CFLAGS = -O 440 | ``` 441 | 同样，模式变量的语法和“目标变量”一样： 442 | 443 | ``` 444 | ; : ; 445 | 446 | ; : override ; 447 | ``` 448 | 449 | override同样是针对于系统环境传入的变量，或是make命令行指定的变量。 450 | 451 | 452 | 453 | 454 | --- 455 | -------------------------------------------------------------------------------- /docs/使用条件判断.md: -------------------------------------------------------------------------------- 1 | # 使用条件判断 2 | 3 | 4 | 使用条件判断，可以让make根据运行时的不同情况选择不同的执行分支。条件表达式可以是比较变量的值， 5 | 或是比较变量和常量的值。 6 | 7 | ## 示例 8 | 9 | 10 | 下面的例子，判断 ```$(CC)``` 变量是否 ```gcc``` ，如果是的话，则使用GNU函数编译目标。 11 | 12 | ``` 13 | libs_for_gcc = -lgnu 14 | normal_libs = 15 | 16 | foo: $(objects) 17 | ifeq ($(CC),gcc) 18 | $(CC) -o foo $(objects) $(libs_for_gcc) 19 | else 20 | $(CC) -o foo $(objects) $(normal_libs) 21 | endif 22 | ``` 23 | 可见，在上面示例的这个规则中，目标 ```foo``` 可以根据变量 ```$(CC)``` 值来选取不同的函数库来 24 | 编译程序。 25 | 26 | 我们可以从上面的示例中看到三个关键字： ```ifeq``` 、 ```else``` 和 ```endif``` 。 27 | 28 | 1. ```ifeq``` 的意思表示条件语句的开始，并指定一个条件表达式，表达式包含两个参数，以逗号分隔，表达式以圆括号括 29 | 起。 30 | 2. ```else``` 表示条件表达式为假的情况。 31 | 3. ```endif``` 表示一个条件语句的结束，任何一个条件表达式都应该以 ```endif``` 结束。 32 | 33 | 当我们的变量 ```$(CC)``` 值是 ```gcc``` 时，目标 ```foo``` 的规则是： 34 | 35 | ``` 36 | foo: $(objects) 37 | $(CC) -o foo $(objects) $(libs_for_gcc) 38 | ``` 39 | 而当我们的变量 ```$(CC)``` 值不是 ```gcc``` 时（比如 ```cc``` ），目标 ```foo``` 的规则是： 40 | 41 | ``` 42 | foo: $(objects) 43 | $(CC) -o foo $(objects) $(normal_libs) 44 | ``` 45 | 当然，我们还可以把上面的那个例子写得更简洁一些： 46 | 47 | ``` 48 | libs_for_gcc = -lgnu 49 | normal_libs = 50 | 51 | ifeq ($(CC),gcc) 52 | libs=$(libs_for_gcc) 53 | else 54 | libs=$(normal_libs) 55 | endif 56 | 57 | foo: $(objects) 58 | $(CC) -o foo $(objects) $(libs) 59 | ``` 60 | 61 | ## 语法 62 | 63 | 条件表达式的语法为:: 64 | ``` 65 | 66 | 67 | endif 68 | ``` 69 | 以及:: 70 | ``` 71 | 72 | 73 | else 74 | 75 | endif 76 | ``` 77 | 其中 `````` 表示条件关键字，如 ```ifeq``` 。这个关键字有四个。 78 | 79 | 第一个是我们前面所见过的 ```ifeq``` 80 | 81 | ``` 82 | ifeq (, ) 83 | ifeq '' '' 84 | ifeq "" "" 85 | ifeq "" '' 86 | ifeq '' "" 87 | ``` 88 | 比较参数 ```arg1``` 和 ```arg2``` 的值是否相同。当然，参数中我们还可以使用make的函数。如:: 89 | ``` 90 | ifeq ($(strip $(foo)),) 91 | 92 | endif 93 | ``` 94 | 这个示例中使用了 ```strip``` 函数，如果这个函数的返回值是空（Empty），那么 95 | `````` 就生效。 96 | 97 | 第二个条件关键字是 ```ifneq``` 。语法是： 98 | 99 | ``` 100 | ifneq (, ) 101 | ifneq '' '' 102 | ifneq "" "" 103 | ifneq "" '' 104 | ifneq '' "" 105 | ``` 106 | 107 | 其比较参数 ```arg1``` 和 ```arg2``` 的值是否相同，如果不同，则为真。和 ```ifeq``` 类似。 108 | 109 | 第三个条件关键字是 ```ifdef``` 。语法是： 110 | 111 | ``` 112 | ifdef 113 | ``` 114 | 如果变量 `````` 的值非空，那到表达式为真。否则，表达式为假。当然， 115 | `````` 同样可以是一个函数的返回值。注意， ```ifdef``` 只是测试一个变量 116 | 是否有值，其并不会把变量扩展到当前位置。还是来看两个例子： 117 | 118 | 示例一： 119 | ``` 120 | bar = 121 | foo = $(bar) 122 | ifdef foo 123 | frobozz = yes 124 | else 125 | frobozz = no 126 | endif 127 | ``` 128 | 示例二： 129 | 130 | ``` 131 | foo = 132 | ifdef foo 133 | frobozz = yes 134 | else 135 | frobozz = no 136 | endif 137 | ``` 138 | 第一个例子中， ```$(frobozz)``` 值是 ```yes``` ，第二个则是 ```no```。 139 | 140 | 第四个条件关键字是 ```ifndef``` 。其语法是： 141 | 142 | ``` 143 | ifndef 144 | ``` 145 | 这个我就不多说了，和 ```ifdef``` 是相反的意思。 146 | 147 | 1. **在 `````` 这一行上，多余的空格是被允许的，但是不能以 ```Tab``` 键作为开始（不然就被认为是命令）。** 148 | 2. 注释符 ```#``` 同样也是安全的。 ```else``` 和 ```endif```也一样，只要不是以 ```Tab``` 键开始就行了。 149 | 150 | **特别注意的是，make是在读取Makefile时就计算条件表达式的值，并根据条件表达式的值来选择语句， 151 | 所以，你最好不要把自动化变量（如 ```$@``` 等）放入条件表达式中，因为自动化变量是在运行时才有的。** 152 | 153 | **而且为了避免混乱，make不允许把整个条件语句分成两部分放在不同的文件中。** 154 | -------------------------------------------------------------------------------- /docs/函数.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | - [函数](#函数) 4 | - [函数的调用语法](#函数的调用语法) 5 | - [字符串处理函数](#字符串处理函数) 6 | - [subst(substitude,替换)](#substsubstitude替换) 7 | - [patsubst(pattern substitude,基于模式匹配的替换)](#patsubstpattern-substitude基于模式匹配的替换) 8 | - [strip(去除字串前后空格函数)](#strip去除字串前后空格函数) 9 | - [findstring(查找字符字串)](#findstring查找字符字串) 10 | - [filter(过滤出符合pattern的子串)](#filter过滤出符合pattern的子串) 11 | - [filter-out(反过滤，过滤掉符合pattern的子串)](#filter-out反过滤，过滤掉符合pattern的子串) 12 | - [sort(去掉重复并排序)](#sort去掉重复并排序) 13 | - [word](#word) 14 | - [wordlist](#wordlist) 15 | - [words](#words) 16 | - [firstword](#firstword) 17 | - [文件名操作函数](#文件名操作函数) 18 | - [dir(取字符串目录部分)](#dir取字符串目录部分) 19 | - [notdir(取字符串非目录部分，取文件名)](#notdir取字符串非目录部分，取文件名) 20 | - [suffix(取文件名后缀)](#suffix取文件名后缀) 21 | - [basename(取文件名前缀，去除后缀)](#basename取文件名前缀，去除后缀) 22 | - [addsuffix(给多字串添加后缀)](#addsuffix给多字串添加后缀) 23 | - [addprefix(给多字串添加前缀)](#addprefix给多字串添加前缀) 24 | - [join](#join) 25 | - [foreach函数(循环)](#foreach函数循环) 26 | - [if函数](#if函数) 27 | - [call函数](#call函数) 28 | - [origin函数](#origin函数) 29 | - [shell函数](#shell函数) 30 | - [控制make的函数](#控制make的函数) 31 | 32 | 33 | # 函数 34 | 35 | 在Makefile中可以使用函数来处理变量，从而让我们的命令或是规则更为的灵活和具有智能。make 36 | 所支持的函数也不算很多，不过已经足够我们的操作了。函数调用后，函数的返回值可以当做变量来使用。 37 | 38 | ## 函数的调用语法 39 | 40 | 函数调用，很像变量的使用，也是以 ```$``` 来标识的，其语法如下： 41 | 42 | ``` 43 | $( ) 44 | ``` 45 | 或是:: 46 | ``` 47 | ${ } 48 | ``` 49 | 这里， `````` 就是函数名，make支持的函数不多。 50 | 51 | 1. `````` 为函数的参数，参数间以逗号 ```,``` 分隔，而**函数名和参数之间以“空格”分隔**。 52 | 2. 函数调用以 ```$``` 开头，以圆括号或花括号把函数名和参数括起。 53 | * 感觉很像一个变量，是不是？函数中的参数可以使用变量，为了风格的统一，函数和变量的括号最好一样，如使用 ```$(subst a,b,$(x))``` 这样的形式，而不是 54 | ```$(subst a,b, ${x})``` 的形式。 55 | * 统一会更清楚，也会减少一些不必要的麻烦。 56 | 57 | 还是来看一个示例： 58 | 59 | ``` 60 | comma:= , 61 | empty:= 62 | space:= $(empty) $(empty) 63 | foo:= a b c 64 | bar:= $(subst $(space),$(comma),$(foo)) 65 | ``` 66 | 在这个示例中， ```$(comma)``` 的值是一个逗号。 ```$(space)``` 使用了 ```$(empty)``` 定义了 67 | 一个空格， ```$(foo)``` 的值是 ```a b c``` ， ```$(bar)``` 的定义用，调用了函数 ```subst``` ， 68 | 这是一个替换函数，这个函数有三个参数，第一个参数是被替换字串，第二个参数是替换字串，第三个参数 69 | 是替换操作作用的字串。这个函数也就是把 ```$(foo)``` 中的空格替换成逗号，所以 ```$(bar)``` 的值 70 | 是 ```a,b,c``` 。 71 | 72 | **这里两个empty中间的才是空格，empty没有值** 73 | 74 | ## 字符串处理函数 75 | 76 | ### subst(substitude,替换) 77 | 78 | ``` 79 | $(subst ,,) 80 | ``` 81 | 82 | - 名称：字符串替换函数 83 | - 功能：把字串 `````` 中的 `````` 字符串替换成 `````` 。 84 | - 返回：函数返回被替换过后的字符串。 85 | 86 | - 示例： 87 | 88 | ``` 89 | $(subst ee,EE,feet on the street) 90 | ``` 91 | 92 | 把 ```feet on the street``` 中的 ```ee``` 替换成 ```EE``` ，返回结果是 ```fEEt on the strEEt``` 。 93 | 94 | ### patsubst(pattern substitude,基于模式匹配的替换) 95 | 96 | ``` 97 | $(patsubst ,,) 98 | ``` 99 | 100 | - 名称：模式字符串替换函数。 101 | - 功能：查找 `````` 中的单词（单词以“空格”、“Tab”或“回车”“换行”分隔）是否符合模式 102 | `````` ，如果匹配的话，则以 `````` 替换。 103 | * 这里， `````` 可以包括通配符 ```%``` ，表示任意长度的字串。 104 | * 如果 `````` 中也包含 ```%``` ，那么，`````` 中的这个 ```%``` 将是 `````` 中的那个 ```%``` 所代表的字串。 105 | （可以用 ```\``` 来转义，以 ```\%``` 来表示真实含义的 ```%``` 字符） 106 | - 返回：函数返回被替换过后的字符串。 107 | 108 | 示例： 109 | ``` 110 | $(patsubst %.c,%.o,x.c.c bar.c) 111 | ``` 112 | 113 | 把字串 ```x.c.c bar.c``` 符合模式 ```%.c``` 的单词替换成 ```%.o``` ，返回结果是 114 | ```x.c.o bar.o``` 115 | 116 | - 备注：这和我们前面“变量章节”说过的相关知识有点相似。 117 | 118 | 如 ```$(var:=;)``` 相当于 ```$(patsubst ,,$(var))``` ， 119 | 120 | 而 ```$(var: =)``` 则相当于 ```$(patsubst %,%,$(var))``` 。 121 | 122 | 例如有: 123 | 124 | ``` 125 | objects = foo.o bar.o baz.o， 126 | ``` 127 | 那么， ```$(objects:.o=.c)``` 和 ```$(patsubst %.o,%.c,$(objects))``` 是一样的。 128 | 129 | 130 | ### strip(去除字串前后空格函数) 131 | 132 | ``` 133 | $(strip ) 134 | ``` 135 | 136 | - 名称：去空格函数。 137 | - 功能：去掉 `````` 字串中开头和结尾的空字符。 138 | - 返回：返回被去掉空格的字符串值。 139 | 140 | 示例： 141 | 142 | ``` 143 | $(strip a b c ) 144 | ``` 145 | 146 | 把字串 ``` a b c ``` 去到开头和结尾的空格，结果是 ```a b c``` 。 147 | 148 | ### findstring(查找字符字串) 149 | 150 | ``` 151 | $(findstring ,) 152 | ``` 153 | 154 | - 名称：查找字符串函数 155 | - 功能：在字串 `````` 中查找 `````` 字串。 156 | - 返回：如果找到，那么返回 `````` ，否则返回空字符串。 157 | 158 | 示例： 159 | ``` 160 | $(findstring a,a b c) 161 | $(findstring a,b c) 162 | ``` 163 | 第一个函数返回 ```a``` 字符串，第二个返回空字符串 164 | 165 | ### filter(过滤出符合pattern的子串) 166 | 167 | ``` 168 | $(filter ,) 169 | ``` 170 | 171 | - 名称：过滤函数 172 | - 功能：以 `````` 模式过滤 `````` 字符串中的单词，保留符合模式 173 | `````` 的单词。可以有多个模式。 174 | - 返回：返回符合模式 `````` 的字串。 175 | - 示例： 176 | 177 | ``` 178 | sources := foo.c bar.c baz.s ugh.h 179 | foo: $(sources) 180 | cc $(filter %.c %.s,$(sources)) -o foo 181 | ``` 182 | 183 | ```$(filter %.c %.s,$(sources))``` 返回的值是 ```foo.c bar.c baz.s``` 。 184 | 185 | ### filter-out(反过滤，过滤掉符合pattern的子串) 186 | 187 | ``` 188 | $(filter-out ,) 189 | ``` 190 | 191 | - 名称：反过滤函数 192 | - 功能：以 `````` 模式过滤 `````` 字符串中的单词，去除符合模式 193 | `````` 的单词。可以有多个模式。 194 | - 返回：返回不符合模式 `````` 的字串。 195 | - 示例： 196 | 197 | ``` 198 | objects=main1.o foo.o main2.o bar.o 199 | mains=main1.o main2.o 200 | ``` 201 | 202 | ```$(filter-out $(mains),$(objects))``` 返回值是 ```foo.o bar.o``` 。 203 | 204 | ### sort(去掉重复并排序) 205 | 206 | ``` 207 | $(sort ) 208 | ``` 209 | 210 | - 名称：排序函数 211 | - 功能：给字符串 `````` 中的单词排序（升序）。 212 | - 返回：返回排序后的字符串。 213 | - 示例： ```$(sort foo bar lose)``` 返回 ```bar foo lose``` 。 214 | - 备注： ```sort``` 函数会去掉 `````` 中相同的单词。 215 | 216 | ### word 217 | 218 | ``` 219 | $(word ,) 220 | ``` 221 | 222 | - 名称：取单词函数 223 | - 功能：取字符串 `````` 中第 `````` 个单词。（从一开始） 224 | - 返回：返回字符串 `````` 中第 `````` 个单词。如果 `````` 比 `````` 中的 225 | 单词数要大，那么返回空字符串。 226 | - 示例： ```$(word 2, foo bar baz)``` 返回值是 ```bar``` 。 227 | 228 | ### wordlist 229 | 230 | ``` 231 | $(wordlist ,,) 232 | ``` 233 | 234 | - 名称：取单词串函数 235 | - 功能：从字符串 `````` 中取从 `````` 开始到 `````` 的单词串。 `````` 236 | 和 `````` 是一个数字。 237 | - 返回：返回字符串 `````` 中从 `````` 到 `````` 的单词字串。如果 `````` 238 | 比 `````` 中的单词数要大，那么返回空字符串。如果 `````` 大于 `````` 的单词数， 239 | 那么返回从 `````` 开始，到 `````` 结束的单词串。 240 | - 示例： ```$(wordlist 2, 3, foo bar baz)``` 返回值是 ```bar baz``` 。 241 | 242 | ### words 243 | 244 | ``` 245 | $(words ) 246 | ``` 247 | 248 | - 名称：单词个数统计函数 249 | - 功能：统计 `````` 中字符串中的单词个数。 250 | - 返回：返回 `````` 中的单词数。 251 | - 示例： ```$(words, foo bar baz)``` 返回值是 ```3``` 。 252 | - 备注：如果我们要取 `````` 中最后的一个单词，我们可以这样： 253 | ```$(word $(words ),)``` 。 254 | 255 | ### firstword 256 | 257 | ``` 258 | $(firstword ) 259 | ``` 260 | 261 | - 名称：首单词函数——firstword。 262 | - 功能：取字符串 `````` 中的第一个单词。 263 | - 返回：返回字符串 `````` 的第一个单词。 264 | - 示例： ```$(firstword foo bar)``` 返回值是 ```foo```。 265 | - 备注：这个函数可以用 ```word``` 函数来实现： ```$(word 1,)``` 。 266 | 267 | 以上，是所有的字符串操作函数，如果搭配混合使用，可以完成比较复杂的功能。这里，举一个现实中 268 | 应用的例子。我们知道，make使用 ```VPATH``` 变量来指定“依赖文件”的搜索路径。于是，我们可以 269 | 利用这个搜索路径来指定编译器对头文件的搜索路径参数 ```CFLAGS``` ，如： 270 | 271 | ``` 272 | override CFLAGS += $(patsubst %,-I%,$(subst :, ,$(VPATH))) 273 | ``` 274 | 275 | 如果我们的 ```$(VPATH)``` 值是 ```src:../headers``` ，那么 276 | ```$(patsubst %,-I%,$(subst :, ,$(VPATH)))``` 将返回 ```-Isrc -I../headers``` ， 277 | 这正是cc或gcc搜索头文件路径的参数。 278 | 279 | ## 文件名操作函数 280 | 281 | 下面我们要介绍的函数主要是处理文件名的。每个函数的参数字符串都会被当做一个或是一系列的文件名 282 | 来对待。 283 | 284 | ### dir(取字符串目录部分) 285 | 286 | ``` 287 | $(dir ) 288 | ``` 289 | 290 | - 名称：取目录函数——dir。 291 | - 功能：从文件名序列 `````` 中取出目录部分。目录部分是指最后一个反斜杠（ ```/``` ）之前 292 | 的部分。如果没有反斜杠，那么返回 ```./``` 。 293 | - 返回：返回文件名序列 `````` 的目录部分。 294 | - 示例： ```$(dir src/foo.c hacks)``` 返回值是 ```src/ ./``` 。 295 | 296 | ### notdir(取字符串非目录部分，取文件名) 297 | 298 | ``` 299 | $(notdir ) 300 | ``` 301 | 302 | - 名称：取文件函数——notdir。 303 | - 功能：从文件名序列 `````` 中取出非目录部分。非目录部分是指最後一个反斜杠（ ```/``` ） 304 | 之后的部分。 305 | - 返回：返回文件名序列 `````` 的非目录部分。 306 | - 示例: ```$(notdir src/foo.c hacks)``` 返回值是 ```foo.c hacks``` 。 307 | 308 | ### suffix(取文件名后缀) 309 | 310 | ``` 311 | $(suffix ) 312 | ``` 313 | 314 | - 名称：取后缀函数——suffix。 315 | - 功能：从文件名序列 `````` 中取出各个文件名的后缀。 316 | - 返回：返回文件名序列 `````` 的后缀序列，如果文件没有后缀，则返回空字串。 317 | - 示例： ```$(suffix src/foo.c src-1.0/bar.c hacks)``` 返回值是 ```.c .c```。 318 | 319 | ### basename(取文件名前缀，去除后缀) 320 | 321 | ``` 322 | $(basename ) 323 | ``` 324 | 325 | - 名称：取前缀函数——basename。 326 | - 功能：从文件名序列 `````` 中取出各个文件名的前缀部分。 327 | - 返回：返回文件名序列 `````` 的前缀序列，如果文件没有前缀，则返回空字串。 328 | - 示例： ```$(basename src/foo.c src-1.0/bar.c hacks)``` 返回值是 329 | ```src/foo src-1.0/bar hacks``` 。 330 | 331 | ### addsuffix(给多字串添加后缀) 332 | 333 | ``` 334 | $(addsuffix ,) 335 | ``` 336 | 337 | - 名称：加后缀函数——addsuffix。 338 | - 功能：把后缀 `````` 加到 `````` 中的每个单词后面。 339 | - 返回：返回加过后缀的文件名序列。 340 | - 示例： ```$(addsuffix .c,foo bar)``` 返回值是 ```foo.c bar.c``` 。 341 | 342 | ### addprefix(给多字串添加前缀) 343 | 344 | ``` 345 | $(addprefix ,) 346 | ``` 347 | 348 | - 名称：加前缀函数——addprefix。 349 | - 功能：把前缀 `````` 加到 `````` 中的每个单词后面。 350 | - 返回：返回加过前缀的文件名序列。 351 | - 示例： ```$(addprefix src/,foo bar)``` 返回值是 ```src/foo src/bar``` 。 352 | 353 | ### join 354 | 355 | ``` 356 | $(join ,) 357 | ``` 358 | 359 | - 名称：连接函数——join。 360 | - 功能：把 `````` 中的单词对应地加到 `````` 的单词后面。如果 `````` 的 361 | 单词个数要比 `````` 的多，那么， `````` 中的多出来的单词将保持原样。如果 362 | `````` 的单词个数要比 `````` 多，那么， `````` 多出来的单词将被复制到 363 | `````` 中。 364 | - 返回：返回连接过后的字符串。 365 | 366 | 示例： 367 | 368 | ```$(join aaa bbb , 111 222 333)``` 369 | 370 | 返回值是 ```aaa111 bbb222 333``` 。 371 | 372 | ## foreach函数(循环) 373 | 374 | foreach函数和别的函数非常的不一样。因为这个函数是用来做循环用的，Makefile中的foreach函数 375 | 几乎是仿照于Unix标准Shell（/bin/sh）中的for语句，或是C-Shell（/bin/csh）中的foreach语句 376 | 而构建的。它的语法是： 377 | 378 | ``` 379 | $(foreach ,,) 380 | ``` 381 | 382 | 这个函数的意思是： 383 | 1. 把参数 `````` 中的单词逐一取出放到参数 `````` 所指定的变量中，然后再执行 `````` 所包含的表达式。 384 | 2. 每一次 `````` 会返回一个字符串，循环过程中，`````` 的所返回的每个字符串会以空格分隔，最后当整个循环结束时， `````` 所返回的 385 | 每个字符串所组成的整个字符串（以空格分隔）将会是foreach函数的返回值。 386 | 387 | 所以， `````` 最好是一个变量名， `````` 可以是一个表达式，而 `````` 中一般会 388 | 使用 `````` 这个参数来依次枚举 `````` 中的单词。举个例子： 389 | 390 | ``` 391 | names := a b c d 392 | files := $(foreach n,$(names),$(n).o) 393 | ``` 394 | 上面的例子中， ```$(name)``` 中的单词会被挨个取出，并存到变量 ```n``` 中， ```$(n).o``` 每次 395 | 根据 ```$(n)``` 计算出一个值，这些值以空格分隔，最后作为foreach函数的返回，所以， ```$(files)``` 396 | 的值是 ```a.o b.o c.o d.o``` 。 397 | 398 | 注意，**foreach中的 `````` 参数是一个临时的局部变量，foreach函数执行完后，参数 `````` 399 | 的变量将不在作用，其作用域只在foreach函数当中**。 400 | 401 | ## if函数 402 | 403 | if函数很像GNU的make所支持的条件语句——ifeq（参见前面所述的章节），if函数的语法是： 404 | 405 | ``` 406 | $(if ,) 407 | ``` 408 | 或是 409 | 410 | ``` 411 | $(if ,,) 412 | ``` 413 | 414 | 可见，if函数可以包含“else”部分，或是不含。即if函数的参数可以是两个，也可以是三个。 415 | `````` 参数是if的表达式，如果其返回的为非空字符串，那么这个表达式就相当于返回真， 416 | 于是， `````` 会被计算，否则 `````` 会被计算。 417 | 418 | 而if函数的返回值是： 419 | 1. 如果 `````` 为真（非空字符串），那个 ``````会是整个函数的返回值 420 | 2. 如果 `````` 为假（空字符串），那么 `````` 会是整个函数的返回值，此时如果 `````` 没有被定义，那么，整个函数返回空字串。 421 | 422 | 所以， `````` 和 `````` 只会有一个被计算，类似于C语言中的三目运算符。 423 | 424 | ### call函数 425 | 426 | call函数是唯一一个可以用来创建新的参数化的函数。你可以写一个非常复杂的表达式，这个表达式中， 427 | 你可以定义许多参数，然后你可以call函数来向这个表达式传递参数。其语法是： 428 | 429 | ``` 430 | $(call ,,,...,) 431 | ``` 432 | 433 | 当make执行这个函数时， `````` 参数中的变量，如 ```$(1)``` 、 ```$(2)``` 等，会 434 | 被参数 `````` 、 `````` 、 `````` 依次取代。而 `````` 的 435 | 返回值就是 call 函数的返回值。例如： 436 | 437 | ``` 438 | reverse = $(1) $(2) 439 | foo = $(call reverse,a,b) 440 | ``` 441 | 442 | 那么， ```foo``` 的值就是 ```a b``` 。当然，参数的次序是可以自定义的，不一定是顺序的，如： 443 | 444 | ``` 445 | reverse = $(2) $(1) 446 | foo = $(call reverse,a,b) 447 | ``` 448 | 449 | 此时的 ```foo``` 的值就是 ```b a``` 。 450 | 451 | 需要注意：**在向 call 函数传递参数时要尤其注意空格的使用。** 452 | 453 | call 函数在处理参数时，第2个及其之后的参数中的空格会被保留，因而可能造成一些奇怪的效果。 454 | 455 | 因而在向call函数提供参数时，最安全的做法是去除所有多余的空格。 456 | 457 | ## origin函数 458 | 459 | origin函数不像其它的函数，他并不操作变量的值，他只是告诉你你的这个变量是哪里来的？其语法是： 460 | 461 | ``` 462 | $(origin ) 463 | ``` 464 | 465 | 注意， **`````` 是变量的名字，不应该是引用。所以你最好不要在 `````` 中使用 466 | ```$``` 字符。** 467 | 468 | Origin函数会以其返回值来告诉你这个变量的“出生情况”，下面，是origin函数的返回值: 469 | 470 | 1. ```undefined``` 471 | * 如果 `````` 从来没有定义过，origin函数返回这个值 ```undefined``` 472 | 2. ```default``` 473 | * 如果 `````` 是一个默认的定义，比如“CC”这个变量，这种变量我们将在后面讲述。 474 | 3. ```environment``` 475 | * 如果 `````` 是一个环境变量，并且当Makefile被执行时， ```-e``` 参数没有被打开。 476 | 4. ```file``` 477 | * 如果 `````` 这个变量被定义在Makefile中。 478 | 5. ```command line``` 479 | * 如果 `````` 这个变量是被命令行定义的。 480 | 6. ```override``` 481 | * 如果 `````` 是被override指示符重新定义的。 482 | 7. ```automatic``` 483 | * 如果 `````` 是一个命令运行中的自动化变量。关于自动化变量将在后面讲述。 484 | 485 | 这些信息对于我们编写Makefile是非常有用的，例如，假设我们有一个Makefile其包了一个定义文件Make.def，在 Make.def中定义了一个变量“bletch”，而我们的环境中也有一个环境变量“bletch”， 486 | 487 | 此时，我们想判断一下，如果变量来源于环境，那么我们就把之重定义了，如果来源于Make.def或是命令行等非环境的，那么我们就不重新定义它。于是，在我们的Makefile中，我们可以这样写： 488 | 489 | ``` 490 | ifdef bletch 491 | ifeq "$(origin bletch)" "environment" 492 | bletch = barf, gag, etc. 493 | endif 494 | endif 495 | ``` 496 | 当然，你也许会说，使用 ```override``` 关键字不就可以重新定义环境中的变量了吗？为什么需要使用这样 497 | 的步骤？ 498 | 是的，我们用 ```override``` 是可以达到这样的效果，**可是 ```override``` 过于粗暴，它同时 499 | 会把从命令行定义的变量也覆盖了**，而我们只想重新定义环境传来的，而不想重新定义命令行传来的。 500 | 501 | ## shell函数 502 | 503 | shell函数也不像其它的函数。 504 | 505 | 顾名思义，它的参数应该就是操作系统Shell的命令。它和反引号“`”是相同的功能。这就是说，**shell函数把执行操作系统命令后的输出作为函数返回**。于是，我们可以用操作 506 | 系统命令以及字符串处理命令awk，sed等等命令来生成一个变量，如： 507 | 508 | ``` 509 | contents := $(shell cat foo) 510 | files := $(shell echo *.c) 511 | ``` 512 | 513 | 注意，**这个函数会新生成一个Shell程序来执行命令，所以你要注意其运行性能，如果你的Makefile中 514 | 有一些比较复杂的规则，并大量使用了这个函数，那么对于你的系统性能是有害的。特别是Makefile的 515 | 隐晦的规则可能会让你的shell函数执行的次数比你想像的多得多。** 516 | 517 | ## 控制make的函数 518 | 519 | * ```$(error )``` 520 | * ```$(warning )``` 521 | 522 | make提供了一些函数来控制make的运行。通常，你需要检测一些运行Makefile时的运行时信息，并且 523 | 根据这些信息来决定，你是让make继续执行，还是停止。 524 | 525 | ``` 526 | $(error ) 527 | ``` 528 | 529 | 产生一个致命的错误， `````` 是错误信息。 530 | 531 | **注意，error函数不会在一被使用就会产生错误信息，所以如果你把其定义在某个变量中，并在后续的脚本中使用这个变量，那么也是可以的。** 532 | 533 | 例如： 534 | 535 | 示例一： 536 | 537 | ``` 538 | ifdef ERROR_001 539 | $(error error is $(ERROR_001)) 540 | endif 541 | ``` 542 | 543 | 示例二： 544 | 545 | ``` 546 | ERR = $(error found an error!) 547 | .PHONY: err 548 | err: $(ERR) 549 | ``` 550 | 551 | 示例一会在变量ERROR_001定义了后执行时产生error调用，而示例二则在目录err被执行时才发生error调用。 552 | 553 | ``` 554 | $(warning ) 555 | ``` 556 | 557 | 这个函数很像error函数，只是它并不会让make退出，只是输出一段警告信息，而make继续执行。 558 | -------------------------------------------------------------------------------- /docs/教程.md: -------------------------------------------------------------------------------- 1 | # 教程 2 | 3 | -------------------------------------------------------------------------------- /docs/教程/image/20191207_113729_47.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yifengyou/learn-make/9f022ed6f0b610c46b84c6eab39111bb77a4c136/docs/教程/image/20191207_113729_47.png -------------------------------------------------------------------------------- /docs/教程/image/20191207_113957_59.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yifengyou/learn-make/9f022ed6f0b610c46b84c6eab39111bb77a4c136/docs/教程/image/20191207_113957_59.png -------------------------------------------------------------------------------- /docs/教程/跟我一起写Makefile.md: -------------------------------------------------------------------------------- 1 | # 跟我一起写Makefile 2 | 3 | ## 后序 4 | 5 | 后序 6 | ==== 7 | 8 | 终于到写结束语的时候了，以上基本上就是GNU make的Makefile的所有细节了。其它的厂商的make基本 9 | 上也就是这样的，无论什么样的make，都是以文件的依赖性为基础的，其基本是都是遵循一个标准的。这篇 10 | 文档中80%的技术细节都适用于任何的make，我猜测“函数”那一章的内容可能不是其它make所支持的，而隐 11 | 含规则方面，我想不同的make会有不同的实现，我没有精力来查看GNU的make和VC的nmake、BCB的 make 12 | ，或是别的UNIX下的make有些什么样的差别，一是时间精力不够，二是因为我基本上都是在Unix下使 13 | 用make，以前在SCO Unix和 IBM的AIX，现在在Linux、Solaris、HP-UX、AIX和Alpha下使用 14 | ，Linux和Solaris下更多一点。不过，我可以肯定的是，在Unix下的make，无论是哪种平台，几乎都使 15 | 用了Richard Stallman开发的make和cc/gcc的编译器，而且，基本上都是 GNU的make（公司里所有 16 | 的UNIX机器上都被装上了GNU的东西，所以，使用GNU的程序也就多了一些）。GNU的东西还是很不错的，特 17 | 别是使用得深了以后，越来越觉得GNU的软件的强大，也越来越觉得GNU的在操作系统中（主要是Unix，甚 18 | 至Windows）“杀伤力”。 19 | 20 | 对于上述所有的make的细节，我们不但可以利用make这个工具来编译我们的程序，还可以利用make来完成 21 | 其它的工作，因为规则中的命令可以是任何Shell之下的命令，所以，在Unix下，你不一定只是使用程序语 22 | 言的编译器，你还可以在Makefile中书写其它的命令，如：tar、 awk、mail、sed、cvs、compress 23 | 、ls、rm、yacc、rpm、ftp等等，等等，来完成诸如“程序打包”、“程序备份”、“制作程序安装包”、“提 24 | 交代码”、“使用程序模板”、“合并文件”等等五花八门的功能，文件操作，文件管理，编程开发设计，或是 25 | 其它一些异想天开的东西。比如，以前在书写银行交易程序时，由于银行的交易程序基本一样，就见到有人 26 | 书写了一些交易的通用程序模板，在该模板中把一些网络通讯、数据库操作的、业务操作共性的东西写在一 27 | 个文件中，在这些文件中用些诸如“@@@N、###N”奇怪字串标注一些位置，然后书写交易时，只需按照一种 28 | 特定的规则书写特定的处理，最后在make时，使用awk和sed，把模板中的“@@@N、###N”等字串替代成特 29 | 定的程序，形成C文件，然后再编译。这个动作很像数据库的“扩展C”语言（即在C语言中用“EXEC SQL”的 30 | 样子执行SQL语句，在用cc/gcc编译之前，需要使用“扩展C”的翻译程序，如cpre，把其翻译成标准C）。 31 | 如果你在使用make时有一些更为绝妙的方法，请记得告诉我啊。 32 | 33 | 回头看看整篇文档，不觉记起几年前刚刚开始在Unix下做开发的时候，有人问我会不会写Makefile时，我 34 | 两眼发直，根本不知道在说什么。一开始看到别人在vi中写完程序后输入“!make”时，还以为是vi的功能， 35 | 后来才知道有一个Makefile在作怪，于是上网查啊查，那时又不愿意看英文，发现就根本没有中文的文档介 36 | 绍Makefile，只得看别人写的Makefile，自己瞎碰瞎搞才积累了一点知识，但在很多地方完全是知其然不 37 | 知所以然。后来开始从事UNIX下产品软件的开发，看到一个400人，近200万行代码的大工程，发现要编译 38 | 这样一个庞然大物，如果没有Makefile，那会是多么恐怖的一样事啊。于是横下心来，狠命地读了一堆英文 39 | 文档，才觉得对其掌握了。但发现目前网上对Makefile介绍的文章还是少得那么的可怜，所以想写这样一篇 40 | 文章，共享给大家，希望能对各位有所帮助。 41 | 42 | 现在我终于写完了，看了看文件的创建时间，这篇技术文档也写了两个多月了。发现，自己知道是一回事， 43 | 要写下来，跟别人讲述又是另外一回事，而且，现在越来越没有时间钻研技术细节，所以在写作时，发现在 44 | 阐述一些细节问题时很难做到严谨和精炼，而且对先讲什么后讲什么不是很清楚，所以，还是参考了一些国 45 | 外站点上的资料和提纲，以及一些技术书籍的语言风格，才得以完成。整篇文档的提纲是基于GNU 46 | 的Makefile技术手册的提纲来书写的，并结合了自己的工作经验，以及自己的学习历程。因为从来没有写过 47 | 这么长，这么细的文档，所以一定会有很多地方存在表达问题，语言歧义或是错误。因些，我迫切地等待各 48 | 位给我指正和建议，以及任何的反馈。 49 | 50 | 最后，还是利用这个后序，介绍一下自己。我目前从事于所有Unix平台下的软件研发，主要是做分布式计 51 | 算/网格计算方面的系统产品软件，并且我对于下一代的计算机革命——网格计算非常地感兴趣，对于分布式计 52 | 算、P2P、Web Service、J2EE技术方向也很感兴趣，同时，对于项目实施、团队管理、项目管理也小有心 53 | 得，希望同样和我战斗在“技术和管理并重”的阵线上的年轻一代，能够和我多多地交流。我的MSN是： 54 | haoel@hotmail.com（常用），QQ是：753640（不常用）。（注：请勿给我MSN的邮箱发信，由 55 | 于hotmail的垃圾邮件导致我拒收这个邮箱的所有来信） 56 | 57 | 我欢迎任何形式的交流，无论是讨论技术还是管理，或是其它海阔天空的东西。除了政治和娱乐新闻我不关 58 | 心，其它只要积极向上的东西我都欢迎！ 59 | 60 | 最最后，我还想介绍一下make程序的设计开发者。 61 | 62 | 首当其冲的是：Richard Stallman 63 | 64 | 开源软件的领袖和先驱，从来没有领过一天工资，从来没有使用过Windows操作系统。对于他的事迹和他的 65 | 软件以及他的思想，我无需说过多的话，相信大家对这个人并不比我陌生，这是他的主页 66 | ： 。这里只贴上一张他的近照： 67 | 68 | ![20191207_113729_47](image/20191207_113729_47.png) 69 | 70 | 第二位是：Roland McGrath 71 | 72 | ![20191207_113957_59](image/20191207_113957_59.png) 73 | 74 | 个人主页是： ，下面是他的一些事迹： 75 | 76 | 1. 合作编写了并维护GNU make。 77 | 2. 和Thomas Bushnell一同编写了GNU Hurd。 78 | 3. 编写并维护着GNU C library。 79 | 4. 合作编写并维护着部分的GNU Emacs。 80 | 81 | 在此，向这两位开源项目的斗士致以最真切的敬意。 82 | -------------------------------------------------------------------------------- /docs/概述/make历史: -------------------------------------------------------------------------------- 1 | # make历史 2 | 3 | 当前虽有众多依赖关系检查工具，但是make是应用最广泛的一个。这要归功于它被包含在Unix系统中。 4 | 斯图亚特·费尔德曼在1977年在贝尔实验室里制作了这个软件。 5 | 2003年，斯图亚特·费尔德曼因发明了这样一个重要的工具而接受了美国计算机协会（ACM）颁发的软件系统奖。 6 | 7 | 在make诞生之前，编译工作主要依赖于操作系统里面的类似于“make”、“install”功能的shell脚本。 8 | 它可以批量执行生成目标的命令，并且可以完成依赖关系的检查。这是向现代编译环境发展的重要一步。 9 | -------------------------------------------------------------------------------- /docs/概述/make基本原理: -------------------------------------------------------------------------------- 1 | # make基本原理 2 | 3 | ## 程序编译连接 4 | 5 | * 一般来说，无论是C还是C++，首先要把源文件编译成中间代码文件，在Windows下也就是 ```.obj``` 文件，UNIX下是 ```.o``` 文件，即Object File，这个动作叫做**编译（compile）**。然后再把大量的Object File合成执行文件，这个动作叫作**链接（link）**。 6 | * **编译时，编译器需要的是语法的正确，函数与变量的声明的正确。对于后者，通常是你需要告诉编译器头文件的所在位置（头文件中应该只是声明，而定义应该放在C/C++文件中），只要所有的语法正确，编译器就可以编译出中间目标文件。一般来说，每个源文件都应该对应于一个中间目标文件（ ```.o``` 文件或 ```.obj``` 文件）**。 7 | * 链接时，主要是链接函数和全局变量。所以，我们可以使用这些中间目标文件（ ```.o``` 文件或 ```.obj``` 文件）来链接我们的应用程序。链接器并不管函数所在的源文件，只管函数的中间目标文件 （Object File），在大多数时候，由于源文件太多，编译生成的中间目标文件太多，而在链接时需要明显地指出中间目标文件名，这对于编译很不方便。所以，我们要给中间目标文件打个包，在Windows下这种包 叫“库文件”（Library File），也就是 ```.lib``` 文件，在UNIX下，是Archive File，也就是 ```.a``` 文件。 8 | 9 | 总结一下，源文件首先会生成中间目标文件，再由中间目标文件生成执行文件。 10 | 11 | 在编译时，编译器只检测程序语法和函数、变量是否被声明。**如果函数未被声明，编译器会给出一个警告，但可以生成Object File**。 而在链接程序时，链接器会在所有的Object File中找寻函数的实现，如果找不到，那到就会报链接错误码 （Linker Error），在VC下，这种错误一般是： Link 2001错误 ，意思说是说，链接器未能找到函数的实现。你需要指定函数的Object File。 12 | 13 | --- 14 | -------------------------------------------------------------------------------- /docs/隐式规则.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | - [隐式规则](#隐式规则) 4 | - [使用隐含规则](#使用隐含规则) 5 | - [隐含规则一览](#隐含规则一览) 6 | - [隐含规则使用的变量](#隐含规则使用的变量) 7 | - [关于命令的变量](#关于命令的变量) 8 | - [关于命令参数的变量](#关于命令参数的变量) 9 | - [隐含规则链](#隐含规则链) 10 | - [定义模式规则](#定义模式规则) 11 | - [模式规则介绍](#模式规则介绍) 12 | - [模式规则示例](#模式规则示例) 13 | - [自动化变量](#自动化变量) 14 | - [模式的匹配](#模式的匹配) 15 | - [重载内建隐含规则](#重载内建隐含规则) 16 | - [老式风格的“后缀规则”](#老式风格的“后缀规则”) 17 | - [隐含规则搜索算法](#隐含规则搜索算法) 18 | 19 | 20 | # 隐式规则 21 | 22 | 在我们使用Makefile时，有一些我们会经常使用，而且使用频率非常高的东西，比如，我们编译C/C++的 23 | 源程序为中间目标文件（Unix下是 ```.o``` 文件，Windows下是 ```.obj``` 文件）。本章讲述的就是 24 | 一些在Makefile中的“隐含的”，早先约定了的，不需要我们再写出来的规则。 25 | 26 | “隐含规则”也就是一种惯例，make会按照这种“惯例”心照不喧地来运行，那怕我们的Makefile中没有书写 27 | 这样的规则。例如，把 ```.c``` 文件编译成 ```.o``` 文件这一规则，你根本就不用写出来，make会自动 28 | 推导出这种规则，并生成我们需要的 ```.o``` 文件。 29 | 30 | “隐含规则”会使用一些我们系统变量，我们可以改变这些系统变量的值来定制隐含规则的运行时的参数。 31 | 如系统变量 ```CFLAGS``` 可以控制编译时的编译器参数。 32 | 33 | 我们还可以通过“模式规则”的方式写下自己的隐含规则。用“后缀规则”来定义隐含规则会有许多的限制。 34 | 使用“模式规则”会更回得智能和清楚，但“后缀规则”可以用来保证我们Makefile的兼容性。 35 | 我们了解了“隐含规则”，可以让其为我们更好的服务，也会让我们知道一些“约定俗成”了的东西，而不至于 36 | 使得我们在运行Makefile时出现一些我们觉得莫名其妙的东西。当然，任何事物都是矛盾的，水能载舟， 37 | 亦可覆舟，所以，有时候“隐含规则”也会给我们造成不小的麻烦。只有了解了它，我们才能更好地使用它。 38 | 39 | ## 使用隐含规则 40 | 41 | 如果要使用隐含规则生成你需要的目标，你所需要做的就是不要写出这个目标的规则。那么，make会试图去 42 | 自动推导产生这个目标的规则和命令，如果 make可以自动推导生成这个目标的规则和命令，那么这个行为 43 | 就是隐含规则的自动推导。当然，隐含规则是make事先约定好的一些东西。例如，我们有下面的一个Makefile： 44 | 45 | ``` 46 | foo : foo.o bar.o 47 | cc –o foo foo.o bar.o $(CFLAGS) $(LDFLAGS) 48 | ``` 49 | 50 | 我们可以注意到，这个Makefile中并没有写下如何生成 ```foo.o``` 和 ```bar.o``` 这两目标的规则和命令。 51 | 因为make的“隐含规则”功能会自动为我们自动去推导这两个目标的依赖目标和生成命令。 52 | 53 | make会在自己的“隐含规则”库中寻找可以用的规则，如果找到，那么就会使用。如果找不到，那么就会报错。 54 | 在上面的那个例子中，make调用的隐含规则是，把 ```.o``` 的目标的依赖文件置成 ```.c``` ，并使用C的 55 | 编译命令 ```cc –c $(CFLAGS) foo.c``` 来生成 ```foo.o``` 的目标。也就是说，我们完全没有必要 56 | 写下下面的两条规则： 57 | 58 | ``` 59 | foo.o : foo.c 60 | cc –c foo.c $(CFLAGS) 61 | bar.o : bar.c 62 | cc –c bar.c $(CFLAGS) 63 | ``` 64 | 65 | 因为，这已经是“约定”好了的事了，make和我们约定好了用C编译器 ```cc``` 生成 ```.o``` 文件的规则， 66 | 这就是隐含规则。 67 | 68 | 当然，如果我们为 ```.o``` 文件书写了自己的规则，那么make就不会自动推导并调用隐含规则，它会按照 69 | 我们写好的规则忠实地执行。 70 | 71 | 还有，在make的“隐含规则库”中，每一条隐含规则都在库中有其顺序，越靠前的则是越被经常使用的，所以， 72 | 这会导致我们有些时候即使我们显示地指定了目标依赖，make也不会管。如下面这条规则（没有命令）： 73 | 74 | ``` 75 | foo.o : foo.p 76 | ``` 77 | 78 | 依赖文件 ```foo.p``` （Pascal程序的源文件）有可能变得没有意义。如果目录下存在了 ```foo.c``` 文件， 79 | 那么我们的隐含规则一样会生效，并会通过 ```foo.c``` 调用C的编译器生成 ```foo.o``` 文件。因为，在 80 | 隐含规则中，Pascal的规则出现在C的规则之后，所以，make找到可以生成 ```foo.o``` 的C的规则就不再 81 | 寻找下一条规则了。如果你确实不希望任何隐含规则推导，那么，你就不要只写出“依赖规则”，而不写命令。 82 | 83 | ## 隐含规则一览 84 | 85 | 这里我们将讲述所有预先设置（也就是make内建）的隐含规则，如果我们不明确地写下规则，那么，make就 86 | 会在这些规则中寻找所需要规则和命令。当然，我们也可以使用make的参数 ```-r``` 或 ```--no-builtin-rules``` 87 | 选项来取消所有的预设置的隐含规则。 88 | 89 | 当然，即使是我们指定了 ```-r``` 参数，某些隐含规则还是会生效，因为有许多的隐含规则都是使用了 90 | “后缀规则”来定义的，所以，只要隐含规则中有 “后缀列表”（也就一系统定义在目标 ```.SUFFIXES``` 91 | 的依赖目标），那么隐含规则就会生效。默认的后缀列表是： 92 | .out, .a, .ln, .o, .c, .cc, .C, .p, .f, .F, .r, .y, .l, .s, .S, .mod, .sym, 93 | .def, .h, .info, .dvi, .tex, .texinfo, .texi, .txinfo, .w, .ch .web, .sh, .elc, .el。 94 | 具体的细节，我们会在后面讲述。 95 | 96 | 还是先来看一看常用的隐含规则吧。 97 | 98 | #. 编译C程序的隐含规则。 99 | 100 | ```.o``` 的目标的依赖目标会自动推导为 ```.c``` ，并且其生成命令是 ```$(CC) –c $(CPPFLAGS) $(CFLAGS)``` 101 | 102 | #. 编译C++程序的隐含规则。 103 | 104 | ```.o``` 的目标的依赖目标会自动推导为 ```.cc``` 或是 ```.C``` ，并且其生成命令是 105 | ```$(CXX) –c $(CPPFLAGS) $(CFLAGS)``` 。（建议使用 ```.cc``` 作为C++源文件的后缀，而不是 ```.C``` ） 106 | 107 | #. 编译Pascal程序的隐含规则。 108 | 109 | ```.o``` 的目标的依赖目标会自动推导为 ```.p``` ，并且其生成命令是 ```$(PC) –c $(PFLAGS)``` 。 110 | 111 | #. 编译Fortran/Ratfor程序的隐含规则。 112 | 113 | ```.o``` 的目标的依赖目标会自动推导为 ```.r``` 或 ```.F``` 或 ```.f``` ，并且其生成命令是: 114 | 115 | - ```.f``` ```$(FC) –c $(FFLAGS)``` 116 | - ```.F``` ```$(FC) –c $(FFLAGS) $(CPPFLAGS)``` 117 | - ```.f``` ```$(FC) –c $(FFLAGS) $(RFLAGS)``` 118 | 119 | #. 预处理Fortran/Ratfor程序的隐含规则。 120 | 121 | ```.f``` 的目标的依赖目标会自动推导为 ```.r``` 或 ```.F``` 。这个规则只是转换Ratfor 122 | 或有预处理的Fortran程序到一个标准的Fortran程序。其使用的命令是： 123 | 124 | - ```.F``` ```$(FC) –F $(CPPFLAGS) $(FFLAGS)``` 125 | - ```.r``` ```$(FC) –F $(FFLAGS) $(RFLAGS)``` 126 | 127 | #. 编译Modula-2程序的隐含规则。 128 | 129 | ```.sym``` 的目标的依赖目标会自动推导为 ```.def``` ，并且其生成命令是： 130 | ```$(M2C) $(M2FLAGS) $(DEFFLAGS)``` 。 ```.o``` 的目标的依赖目标会自动推导为 ```.mod``` ， 131 | 并且其生成命令是： ```$(M2C) $(M2FLAGS) $(MODFLAGS)``` 。 132 | 133 | #. 汇编和汇编预处理的隐含规则。 134 | 135 | ```.o``` 的目标的依赖目标会自动推导为 ```.s``` ，默认使用编译品 ```as``` ，并且其生成 136 | 命令是： ```$ (AS) $(ASFLAGS)``` 。 ```.s``` 的目标的依赖目标会自动推导为 ```.S``` ， 137 | 默认使用C预编译器 ```cpp``` ，并且其生成命令是： ```$(AS) $(ASFLAGS)``` 。 138 | 139 | #. 链接Object文件的隐含规则。 140 | 141 | `````` 目标依赖于 ```.o``` ，通过运行C的编译器来运行链接程序生成（一般是 ```ld``` ）， 142 | 其生成命令是： ```$(CC) $(LDFLAGS) .o $(LOADLIBES) $(LDLIBS)``` 。这个规则对于 143 | 只有一个源文件的工程有效，同时也对多个Object文件（由不同的源文件生成）的也有效。例如如下规则:: 144 | 145 | x : y.o z.o 146 | 147 | 并且 ```x.c``` 、 ```y.c``` 和 ```z.c``` 都存在时，隐含规则将执行如下命令:: 148 | 149 | cc -c x.c -o x.o 150 | cc -c y.c -o y.o 151 | cc -c z.c -o z.o 152 | cc x.o y.o z.o -o x 153 | rm -f x.o 154 | rm -f y.o 155 | rm -f z.o 156 | 157 | 如果没有一个源文件（如上例中的x.c）和你的目标名字（如上例中的x）相关联，那么，你最好写出自己 158 | 的生成规则，不然，隐含规则会报错的。 159 | 160 | #. Yacc C程序时的隐含规则。 161 | 162 | ```.c``` 的依赖文件被自动推导为 ```n.y``` （Yacc生成的文件），其生成命令是： ```$(YACC) $(YFALGS)``` 。 163 | （“Yacc”是一个语法分析器，关于其细节请查看相关资料） 164 | 165 | #. Lex C程序时的隐含规则。 166 | 167 | ```.c``` 的依赖文件被自动推导为 ```n.l``` （Lex生成的文件），其生成命令是： ```$(LEX) $(LFALGS)``` 。 168 | （关于“Lex”的细节请查看相关资料） 169 | 170 | #. Lex Ratfor程序时的隐含规则。 171 | 172 | ```.r``` 的依赖文件被自动推导为 ```n.l``` （Lex生成的文件），其生成命令是： ```$(LEX) $(LFALGS)``` 。 173 | 174 | #. 从C程序、Yacc文件或Lex文件创建Lint库的隐含规则。 175 | 176 | ```.ln``` （lint生成的文件）的依赖文件被自动推导为 ```n.c``` ，其生成命令是： 177 | ```$(LINT) $(LINTFALGS) $(CPPFLAGS) -i``` 。对于 ```.y``` 和 ```.l``` 也是同样的规则。 178 | 179 | ## 隐含规则使用的变量 180 | 181 | 在隐含规则中的命令中，基本上都是使用了一些预先设置的变量。你可以在你的makefile中改变这些变量的值， 182 | 或是在make的命令行中传入这些值，或是在你的环境变量中设置这些值，无论怎么样，只要设置了这些特定的变量， 183 | 那么其就会对隐含规则起作用。当然，你也可以利用make的 ```-R``` 或 ```--no–builtin-variables``` 184 | 参数来取消你所定义的变量对隐含规则的作用。 185 | 186 | 例如，第一条隐含规则——编译C程序的隐含规则的命令是 ```$(CC) –c $(CFLAGS) $(CPPFLAGS)``` 。 187 | Make默认的编译命令是 ```cc``` ，如果你把变量 ```$(CC)``` 重定义成 ```gcc``` ，把变量 ```$(CFLAGS)``` 188 | 重定义成 ```-g``` ，那么，隐含规则中的命令全部会以 ```gcc –c -g $(CPPFLAGS)``` 的样子来执行了。 189 | 190 | 我们可以把隐含规则中使用的变量分成两种：一种是命令相关的，如 ```CC``` ；一种是参数相的关，如 191 | ```CFLAGS``` 。下面是所有隐含规则中会用到的变量： 192 | 193 | ### 关于命令的变量 194 | 195 | - ```AR``` : 函数库打包程序。默认命令是 ```ar``` 196 | - ```AS``` : 汇编语言编译程序。默认命令是 ```as``` 197 | - ```CC``` : C语言编译程序。默认命令是 ```cc``` 198 | - ```CXX``` : C++语言编译程序。默认命令是 ```g++``` 199 | - ```CO``` : 从 RCS文件中扩展文件程序。默认命令是 ```co``` 200 | - ```CPP``` : C程序的预处理器（输出是标准输出设备）。默认命令是 ```$(CC) –E``` 201 | - ```FC``` : Fortran 和 Ratfor 的编译器和预处理程序。默认命令是 ```f77``` 202 | - ```GET``` : 从SCCS文件中扩展文件的程序。默认命令是 ```get``` 203 | - ```LEX``` : Lex方法分析器程序（针对于C或Ratfor）。默认命令是 ```lex``` 204 | - ```PC``` : Pascal语言编译程序。默认命令是 ```pc``` 205 | - ```YACC``` : Yacc文法分析器（针对于C程序）。默认命令是 ```yacc``` 206 | - ```YACCR``` : Yacc文法分析器（针对于Ratfor程序）。默认命令是 ```yacc –r``` 207 | - ```MAKEINFO``` : 转换Texinfo源文件（.texi）到Info文件程序。默认命令是 ```makeinfo``` 208 | - ```TEX``` : 从TeX源文件创建TeX DVI文件的程序。默认命令是 ```tex``` 209 | - ```TEXI2DVI``` : 从Texinfo源文件创建军TeX DVI 文件的程序。默认命令是 ```texi2dvi``` 210 | - ```WEAVE``` : 转换Web到TeX的程序。默认命令是 ```weave``` 211 | - ```CWEAVE``` : 转换C Web 到 TeX的程序。默认命令是 ```cweave``` 212 | - ```TANGLE``` : 转换Web到Pascal语言的程序。默认命令是 ```tangle``` 213 | - ```CTANGLE``` : 转换C Web 到 C。默认命令是 ```ctangle``` 214 | - ```RM``` : 删除文件命令。默认命令是 ```rm –f``` 215 | 216 | ### 关于命令参数的变量 217 | 218 | 下面的这些变量都是相关上面的命令的参数。如果没有指明其默认值，那么其默认值都是空。 219 | 220 | - ```ARFLAGS``` : 函数库打包程序AR命令的参数。默认值是 ```rv``` 221 | - ```ASFLAGS``` : 汇编语言编译器参数。（当明显地调用 ```.s``` 或 ```.S``` 文件时） 222 | - ```CFLAGS``` : C语言编译器参数。 223 | - ```CXXFLAGS``` : C++语言编译器参数。 224 | - ```COFLAGS``` : RCS命令参数。 225 | - ```CPPFLAGS``` : C预处理器参数。（ C 和 Fortran 编译器也会用到）。 226 | - ```FFLAGS``` : Fortran语言编译器参数。 227 | - ```GFLAGS``` : SCCS “get”程序参数。 228 | - ```LDFLAGS``` : 链接器参数。（如： ```ld``` ） 229 | - ```LFLAGS``` : Lex文法分析器参数。 230 | - ```PFLAGS``` : Pascal语言编译器参数。 231 | - ```RFLAGS``` : Ratfor 程序的Fortran 编译器参数。 232 | - ```YFLAGS``` : Yacc文法分析器参数。 233 | 234 | ## 隐含规则链 235 | 236 | 有些时候，一个目标可能被一系列的隐含规则所作用。例如，一个 ```.o``` 的文件生成，可能会是先被 237 | Yacc的[.y]文件先成 ```.c``` ，然后再被C的编译器生成。我们把这一系列的隐含规则叫做“隐含规则链”。 238 | 239 | 在上面的例子中，如果文件 ```.c``` 存在，那么就直接调用C的编译器的隐含规则，如果没有 ```.c``` 文件， 240 | 但有一个 ```.y``` 文件，那么Yacc的隐含规则会被调用，生成 ```.c``` 文件，然后，再调用C编译的隐含 241 | 规则最终由 ```.c``` 生成 ```.o``` 文件，达到目标。 242 | 243 | 我们把这种 ```.c``` 的文件（或是目标），叫做中间目标。不管怎么样，make会努力自动推导生成目标的 244 | 一切方法，不管中间目标有多少，其都会执着地把所有的隐含规则和你书写的规则全部合起来分析，努力达到 245 | 目标，所以，有些时候，可能会让你觉得奇怪，怎么我的目标会这样生成？怎么我的 makefile发疯了？ 246 | 247 | 在默认情况下，对于中间目标，它和一般的目标有两个地方所不同：第一个不同是除非中间的目标不存在， 248 | 才会引发中间规则。第二个不同的是，只要目标成功产生，那么，产生最终目标过程中，所产生的中间目标 249 | 文件会被以 ```rm -f``` 删除。 250 | 251 | 通常，一个被makefile指定成目标或是依赖目标的文件不能被当作中介。然而，你可以明显地说明一个 252 | 文件或是目标是中介目标，你可以使用伪目标 ```.INTERMEDIATE``` 来强制声明。 253 | （如： ```.INTERMEDIATE : mid``` ） 254 | 255 | 你也可以阻止make自动删除中间目标，要做到这一点，你可以使用伪目标 ```.SECONDARY``` 来强制声明 256 | （如： ```.SECONDARY : sec``` ）。你还可以把你的目标，以模式的方式来指定（如： ```%.o``` ）成 257 | 伪目标 ```.PRECIOUS``` 的依赖目标，以保存被隐含规则所生成的中间文件。 258 | 259 | 在“隐含规则链”中，禁止同一个目标出现两次或两次以上，这样一来，就可防止在make自动推导时出现 260 | 无限递归的情况。 261 | 262 | Make会优化一些特殊的隐含规则，而不生成中间文件。如，从文件 ```foo.c``` 生成目标程序 ```foo``` ， 263 | 按道理，make会编译生成中间文件 ```foo.o``` ，然后链接成 ```foo``` ，但在实际情况下，这一动作可以 264 | 被一条 ```cc``` 的命令完成（ ```cc –o foo foo.c``` ），于是优化过的规则就不会生成中间文件。 265 | 266 | ## 定义模式规则 267 | 268 | 你可以使用模式规则来定义一个隐含规则。一个模式规则就好像一个一般的规则，只是在规则中，目标的定义 269 | 需要有 ```%``` 字符。 ```%``` 的意思是表示一个或多个任意字符。在依赖目标中同样可以使用 ```%``` ， 270 | 只是依赖目标中的 ```%``` 的取值，取决于其目标。 271 | 272 | 有一点需要注意的是， ```%``` 的展开发生在变量和函数的展开之后，变量和函数的展开发生在make载入 273 | Makefile时，而模式规则中的 ```%``` 则发生在运行时。 274 | 275 | ### 模式规则介绍 276 | 277 | 模式规则中，至少在规则的目标定义中要包含 ```%``` ，否则，就是一般的规则。目标中的 ```%``` 定义 278 | 表示对文件名的匹配， ```%``` 表示长度任意的非空字符串。例如： ```%.c``` 表示以 ```.c``` 结尾的 279 | 文件名（文件名的长度至少为3），而 ```s.%.c``` 则表示以 ```s.``` 开头， ```.c``` 结尾的文件名 280 | （文件名的长度至少为5）。 281 | 282 | 如果 ```%``` 定义在目标中，那么，目标中的 ```%``` 的值决定了依赖目标中的 ```%``` 的值，也就是说， 283 | 目标中的模式的 ```%``` 决定了依赖目标中 ```%``` 的样子。例如有一个模式规则如下： 284 | 285 | ``` 286 | %.o : %.c ; ; 287 | ``` 288 | 289 | 其含义是，指出了怎么从所有的 ```.c``` 文件生成相应的 ```.o``` 文件的规则。如果要生成的目标是 290 | ```a.o b.o``` ，那么 ```%c``` 就是 ```a.c b.c``` 。 291 | 292 | 一旦依赖目标中的 ```%``` 模式被确定，那么，make会被要求去匹配当前目录下所有的文件名，一旦找到， 293 | make就会规则下的命令，所以，在模式规则中，目标可能会是多个的，如果有模式匹配出多个目标，make就 294 | 会产生所有的模式目标，此时，make关心的是依赖的文件名和生成目标的命令这两件事。 295 | 296 | ### 模式规则示例 297 | 298 | 下面这个例子表示了,把所有的 ```.c``` 文件都编译成 ```.o``` 文件. 299 | 300 | ``` 301 | %.o : %.c 302 | $(CC) -c $(CFLAGS) $(CPPFLAGS) $< -o $@ 303 | ``` 304 | 305 | 其中， ```$@``` 表示所有的目标的挨个值， ```$<``` 表示了所有依赖目标的挨个值。这些奇怪的变量我们 306 | 叫“自动化变量”，后面会详细讲述。 307 | 308 | 下面的这个例子中有两个目标是模式的： 309 | 310 | ``` 311 | %.tab.c %.tab.h: %.y 312 | bison -d $< 313 | ``` 314 | 315 | 这条规则告诉make把所有的 ```.y``` 文件都以 ```bison -d .y``` 执行，然后生成 ```.tab.c``` 316 | 和 ```.tab.h``` 文件。（其中， `````` 表示一个任意字符串）。如果我们的执行程序 ```foo``` 317 | 依赖于文件 ```parse.tab.o``` 和 ```scan.o``` ，并且文件 ```scan.o``` 依赖于文件 ```parse.tab.h``` ， 318 | 如果 ```parse.y``` 文件被更新了，那么根据上述的规则， ```bison -d parse.y``` 就会被执行一次， 319 | 于是， ```parse.tab.o``` 和 ```scan.o``` 的依赖文件就齐了。（假设， ```parse.tab.o``` 由 320 | ```parse.tab.c``` 生成，和 ```scan.o``` 由 ```scan.c``` 生成，而 ```foo``` 由 ```parse.tab.o``` 321 | 和 ```scan.o``` 链接生成，而且 ```foo``` 和其 ```.o``` 文件的依赖关系也写好，那么，所有的目标都会得到满足） 322 | 323 | ### 自动化变量 324 | 325 | 在上述的模式规则中，目标和依赖文件都是一系例的文件，那么我们如何书写一个命令来完成从不同的依赖 326 | 文件生成相应的目标？因为在每一次的对模式规则的解析时，都会是不同的目标和依赖文件。 327 | 328 | 自动化变量就是完成这个功能的。在前面，我们已经对自动化变量有所提涉，相信你看到这里已对它有一个 329 | 感性认识了。所谓自动化变量，就是这种变量会把模式中所定义的一系列的文件自动地挨个取出，直至所有的 330 | 符合模式的文件都取完了。这种自动化变量只应出现在规则的命令中。 331 | 332 | 下面是所有的自动化变量及其说明： 333 | 334 | - ```$@``` : 表示规则中的目标文件集。在模式规则中，如果有多个目标，那么， ```$@``` 就是匹配于 335 | 目标中模式定义的集合。 336 | - ```$%``` : 仅当目标是函数库文件中，表示规则中的目标成员名。例如，如果一个目标是 ```foo.a(bar.o)``` ， 337 | 那么， ```$%``` 就是 ```bar.o``` ， ```$@``` 就是 ```foo.a``` 。如果目标不是函数库文件 338 | （Unix下是 ```.a``` ，Windows下是 ```.lib``` ），那么，其值为空。 339 | - ```$<``` : 依赖目标中的第一个目标名字。如果依赖目标是以模式（即 ```%``` ）定义的，那么 ```$<``` 340 | 将是符合模式的一系列的文件集。注意，其是一个一个取出来的。 341 | - ```$?``` : 所有比目标新的依赖目标的集合。以空格分隔。 342 | - ```$^``` : 所有的依赖目标的集合。以空格分隔。如果在依赖目标中有多个重复的，那个这个变量会去除 343 | 重复的依赖目标，只保留一份。 344 | - ```$+``` : 这个变量很像 ```$^``` ，也是所有依赖目标的集合。只是它不去除重复的依赖目标。 345 | - ```$*``` : 这个变量表示目标模式中 ```%``` 及其之前的部分。如果目标是 ```dir/a.foo.b``` ，并且 346 | 目标的模式是 ```a.%.b``` ，那么， ```$*``` 的值就是 ```dir/a.foo``` 。这个变量对于构造有关联的 347 | 文件名是比较有较。如果目标中没有模式的定义，那么 ```$*``` 也就不能被推导出，但是，如果目标文件的 348 | 后缀是make所识别的，那么 ```$*``` 就是除了后缀的那一部分。例如：如果目标是 ```foo.c``` ，因为 349 | ```.c``` 是make所能识别的后缀名，所以， ```$*``` 的值就是 ```foo``` 。这个特性是GNU make的， 350 | 很有可能不兼容于其它版本的make，所以，你应该尽量避免使用 ```$*``` ，除非是在隐含规则或是静态 351 | 模式中。如果目标中的后缀是make所不能识别的，那么 ```$*``` 就是空值。 352 | 353 | 当你希望只对更新过的依赖文件进行操作时， ```$?``` 在显式规则中很有用，例如，假设有一个函数库文件 354 | 叫 ```lib``` ，其由其它几个object文件更新。那么把object文件打包的比较有效率的Makefile规则是： 355 | 356 | ``` 357 | lib : foo.o bar.o lose.o win.o 358 | ar r lib $? 359 | ``` 360 | 在上述所列出来的自动量变量中。四个变量（ ```$@``` 、 ```$<``` 、 ```$%``` 、 ```$*``` ）在扩展时 361 | 只会有一个文件，而另三个的值是一个文件列表。这七个自动化变量还可以取得文件的目录名或是在当前 362 | 目录下的符合模式的文件名，只需要搭配上 ```D``` 或 ```F``` 字样。这是GNU make中老版本的特性， 363 | 在新版本中，我们使用函数 ```dir``` 或 ```notdir``` 就可以做到了。 ```D``` 的含义就是Directory， 364 | 就是目录， ```F``` 的含义就是File，就是文件。 365 | 366 | 下面是对于上面的七个变量分别加上 ```D``` 或是 ```F``` 的含义： 367 | 368 | ```$(@D)``` 369 | 表示 ```$@``` 的目录部分（不以斜杠作为结尾），如果 ```$@``` 值是 ```dir/foo.o``` ，那么 370 | ```$(@D)``` 就是 ```dir``` ，而如果 ```$@``` 中没有包含斜杠的话，其值就是 ```.``` （当前目录）。 371 | 372 | ```$(@F)``` 373 | 表示 ```$@``` 的文件部分，如果 ```$@``` 值是 ```dir/foo.o``` ，那么 ```$(@F)``` 就是 ```foo.o``` ， 374 | ```$(@F)``` 相当于函数 ```$(notdir $@)``` 。 375 | 376 | ```$(*D)```, ```$(*F)``` 377 | 和上面所述的同理，也是取文件的目录部分和文件部分。对于上面的那个例子， ```$(*D)``` 返回 ```dir``` ， 378 | 而 ```$(*F)``` 返回 ```foo``` 379 | 380 | ```$(%D)```, ```$(%F)``` 381 | 分别表示了函数包文件成员的目录部分和文件部分。这对于形同 ```archive(member)``` 形式的目标中的 382 | ```member``` 中包含了不同的目录很有用。 383 | 384 | ```$(