fix rst format

This commit is contained in:
Dongdong Tian
2015-11-09 14:41:39 +08:00
parent 956141d25f
commit 51ddffaab3
6 changed files with 191 additions and 192 deletions

View File

@@ -16,10 +16,10 @@
foo.o: foo.c defs.h # foo模块
cc -c -g foo.c
看到这个例子,各位应该不是很陌生了,前面也已说过,foo.o是我们的目标foo.c和defs.h是目标所依赖的源文件,而只有一个命令\ ``cc -c -g foo.c``\ 以Tab键开头。这个规则告诉我们两件事
看到这个例子,各位应该不是很陌生了,前面也已说过, ``foo.o`` 是我们的目标, ``foo.c````defs.h`` 是目标所依赖的源文件,而只有一个命令 ``cc -c -g foo.c`` 以Tab键开头。这个规则告诉我们两件事
#. 文件的依赖关系,foo.o依赖于foo.c和defs.h的文件如果foo.c和defs.h的文件日期要比foo.o文件日期要新或是foo.o不存在,那么依赖关系发生。
#. 生成或更新foo.o文件就是那个cc命令。它说明了如何生成foo.o这个文件。当然foo.c文件include了defs.h文件
#. 文件的依赖关系, ``foo.o`` 依赖于 ``foo.c````defs.h`` 的文件,如果 ``foo.c````defs.h`` 的文件日期要比 ``foo.o`` 文件日期要新,或是 ``foo.o`` 不存在,那么依赖关系发生。
#. 生成或更新 ``foo.o`` 文件就是那个cc命令。它说明了如何生成 ``foo.o`` 这个文件。当然foo.c文件include了defs.h文件
规则的语法
----------
@@ -40,20 +40,20 @@
targets是文件名以空格分开可以使用通配符。一般来说我们的目标基本上是一个文件但也有可能是多个文件。
command是命令行如果其不与“target:prerequisites”在一行那么必须以[Tab键]开头如果和prerequisites在一行那么可以用分号做为分隔。见上
command是命令行如果其不与“target:prerequisites”在一行那么必须以 ``Tab``开头如果和prerequisites在一行那么可以用分号做为分隔。见上
prerequisites也就是目标所依赖的文件或依赖目标。如果其中的某个文件要比目标文件要新那么目标就被认为是“过时的”被认为是需要重生成的。这个在前面已经讲过了。
如果命令太长,你可以使用反斜框(\\作为换行符。make对一行上有多少个字符没有限制。规则告诉make两件事文件的依赖关系和如何生成目标文件。
如果命令太长,你可以使用反斜框( ``\`` 作为换行符。make对一行上有多少个字符没有限制。规则告诉make两件事文件的依赖关系和如何生成目标文件。
一般来说make会以UNIX的标准Shell也就是\ ``/bin/sh``\ 来执行命令。
一般来说make会以UNIX的标准Shell也就是 ``/bin/sh`` 来执行命令。
在规则中使用通配符
------------------
如果我们想定义一系列比较类似的文件我们很自然地就想起使用通配符。make支持三个通配符“*”,“?”和“~”。这是和Unix的B-Shell是相同的。
如果我们想定义一系列比较类似的文件我们很自然地就想起使用通配符。make支持三个通配符 ``*`` ``?````~`` 。这是和Unix的B-Shell是相同的。
波浪号(“~”)字符在文件名中也有比较特殊的用途。如果是“~/test”,这就表示当前用户的$HOME目录下的test目录。而 ~hchen/test则表示用户hchen的宿主目录下的test目录。这些都是Unix下的小知识了make也支持而在Windows或是 MS-DOS下用户没有宿主目录那么波浪号所指的目录则根据环境变量“HOME”而定。
波浪号( ``~`` )字符在文件名中也有比较特殊的用途。如果是 ``~/test`` ,这就表示当前用户的$HOME目录下的test目录。而 ``~hchen/test`` 则表示用户hchen的宿主目录下的test目录。这些都是Unix下的小知识了make也支持而在Windows或是 MS-DOS下用户没有宿主目录那么波浪号所指的目录则根据环境变量“HOME”而定。
通配符代替了你一系列的文件,如 ``*.c`` 表示所有后缀为c的文件。一个需要我们注意的是如果我们的文件名中有通配符 ``*`` ,那么可以用转义字符 ``\`` ,如 ``\*`` 来表示真实的 ``*`` 字符,而不是任意长度的字符串。
@@ -80,13 +80,13 @@ prerequisites也就是目标所依赖的文件或依赖目标。如果其
lpr -p $?
touch print
上面这个例子说明了通配符也可以在我们的规则中目标print依赖于所有的[.c]文件。其中的“$?”是一个自动化变量,我会在后面给你讲述。
上面这个例子说明了通配符也可以在我们的规则中目标print依赖于所有的 ``.c`` 文件。其中的 ``$?`` 是一个自动化变量,我会在后面给你讲述。
.. code-block:: makefile
objects = *.o
上面这个例子,表示了通配符同样可以用在变量中。并不是说\ ``*.o``\ 会展开objects的值就是\ ``*.o``\ 。Makefile中的变量其实就是C/C++中的宏。如果你要让通配符在变量中展开也就是让objects的值是所有[.o]的文件名的集合,那么,你可以这样:
上面这个例子,表示了通配符同样可以用在变量中。并不是说 ``*.o`` 会展开objects的值就是 ``*.o`` 。Makefile中的变量其实就是C/C++中的宏。如果你要让通配符在变量中展开也就是让objects的值是所有 ``.o`` 的文件名的集合,那么,你可以这样:
.. code-block:: makefile
@@ -94,19 +94,19 @@ prerequisites也就是目标所依赖的文件或依赖目标。如果其
另给一个变量使用通配符的例子:
#. 列出一确定文件夹中的所有“.c”文件。
#. 列出一确定文件夹中的所有 ``.c`` 文件。
.. code-block:: makefile
objects := $(wildcard *.c)
#. 列出(1)中所有文件对应的“.o”文件3中我们可以看到它是由make自动编译出的。
#. 列出(1)中所有文件对应的 ``.o`` 文件3中我们可以看到它是由make自动编译出的。
.. code-block:: makefile
$(patsubst %.c,%.o,$(wildcard *.c))
#. 由(1)(2)两步,可写出编译并链接所有“.c”和”.o“文件
#. 由(1)(2)两步,可写出编译并链接所有 ``.c````.o`` 文件
.. code-block:: makefile
@@ -121,7 +121,7 @@ prerequisites也就是目标所依赖的文件或依赖目标。如果其
在一些大的工程中有大量的源文件我们通常的做法是把这许多的源文件分类并存放在不同的目录中。所以当make需要去找寻文件的依赖关系时你可以在文件前加上路径但最好的方法是把一个路径告诉make让make在自动去找。
Makefile文件中的特殊变量“VPATH”就是完成这个功能的如果没有指明这个变量make只会在当前的目录中去找寻依赖文件和目标文件。如果定义了这个变量那么make就会在当当前目录找不到的情况下到所指定的目录中去找寻文件了。
Makefile文件中的特殊变量 ``VPATH`` 就是完成这个功能的如果没有指明这个变量make只会在当前的目录中去找寻依赖文件和目标文件。如果定义了这个变量那么make就会在当当前目录找不到的情况下到所指定的目录中去找寻文件了。
.. code-block:: makefile
@@ -131,22 +131,22 @@ Makefile文件中的特殊变量“VPATH”就是完成这个功能的如果
另一个设置文件搜索路径的方法是使用make的“vpath”关键字注意它是全小写的这不是变量这是一个make的关键字这和上面提到的那个VPATH变量很类似但是它更为灵活。它可以指定不同的文件在不同的搜索目录中。这是一个很灵活的功能。它的使用方法有三种
\ ``vpath <pattern> <directories>``\
``vpath <pattern> <directories>``
为符合模式<pattern>的文件指定搜索目录<directories>。
\ ``vpath <pattern>``\
``vpath <pattern>``
清除符合模式<pattern>的文件的搜索目录。
\ ``vpath``\
``vpath``
清除所有已被设置好了的文件搜索目录。
vapth使用方法中的<pattern>需要包含“%”字符。“%”的意思是匹配零或若干字符,(需引用“%”,使用“\\%”)例如,“%.h”表示所有以 “.h”结尾的文件。<pattern>指定了要搜索的文件集,而<directories>则指定了< pattern>的文件集的搜索的目录。例如:
vapth使用方法中的<pattern>需要包含 ``%`` 字符。 ``%`` 的意思是匹配零或若干字符,(需引用 ``%`` ,使用 ``\`` )例如, ``%.h`` 表示所有以 ``.h`` 结尾的文件。<pattern>指定了要搜索的文件集,而<directories>则指定了< pattern>的文件集的搜索的目录。例如:
.. code-block:: makefile
vpath %.h ../headers
该语句表示要求make在“../headers”目录下搜索所有以“.h”结尾的文件。(如果某文件在当前目录没有找到的话)
该语句表示要求make在“../headers”目录下搜索所有以 ``.h`` 结尾的文件。(如果某文件在当前目录没有找到的话)
我们可以连续地使用vpath语句以指定不同搜索策略。如果连续的vpath语句中出现了相同的<pattern>,或是被重复了的<pattern>那么make会按照vpath语句的先后顺序来执行搜索。如
@@ -156,14 +156,14 @@ vapth使用方法中的<pattern>需要包含“%”字符。“%”的意思是
vpath % blish
vpath %.c bar
其表示“.c”结尾的文件先在“foo”目录然后是“blish”最后是“bar”目录。
其表示 ``.c`` 结尾的文件先在“foo”目录然后是“blish”最后是“bar”目录。
.. code-block:: makefile
vpath %.c foo:bar
vpath % blish
而上面的语句则表示“.c”结尾的文件先在“foo”目录然后是“bar”目录最后才是“blish”目录。
而上面的语句则表示 ``.c`` 结尾的文件先在“foo”目录然后是“bar”目录最后才是“blish”目录。
伪目标
------
@@ -209,7 +209,7 @@ vapth使用方法中的<pattern>需要包含“%”字符。“%”的意思是
prog3 : prog3.o sort.o utils.o
cc -o prog3 prog3.o sort.o utils.o
我们知道Makefile中的第一个目标会被作为其默认目标。我们声明了一个“all”的伪目标其依赖于其它三个目标。由于默认目标的特性是总是被执行的但由于“all”又是一个伪目标伪目标只是一个标签不会生成文件所以不会有“all”文件产生。于是其它三个目标的规则总是会被决议。也就达到了我们一口气生成多个目标的目的。.PHONY : all声明了“all”这个目标为“伪目标”。这里的显式 “.PHONY : all” 不写的话一般情况也可以正确的执行这样make可通过隐式规则推导出 “all” 是一个伪目标执行make不会生成“all”文件而执行后面的多个目标。建议显式写出是一个好习惯。
我们知道Makefile中的第一个目标会被作为其默认目标。我们声明了一个“all”的伪目标其依赖于其它三个目标。由于默认目标的特性是总是被执行的但由于“all”又是一个伪目标伪目标只是一个标签不会生成文件所以不会有“all”文件产生。于是其它三个目标的规则总是会被决议。也就达到了我们一口气生成多个目标的目的。 ``.PHONY : all`` 声明了“all”这个目标为“伪目标”。这里的显式 “.PHONY : all” 不写的话一般情况也可以正确的执行这样make可通过隐式规则推导出 “all” 是一个伪目标执行make不会生成“all”文件而执行后面的多个目标。建议显式写出是一个好习惯。
随便提一句,从上面的例子我们可以看出,目标也可以成为依赖。所以,伪目标同样也可成为依赖。看下面的例子:
@@ -231,7 +231,7 @@ vapth使用方法中的<pattern>需要包含“%”字符。“%”的意思是
多目标
------
Makefile的规则中的目标可以不止一个其支持多目标有可能我们的多个目标同时依赖于一个文件并且其生成的命令大体类似。于是我们就能把其合并起来。当然多个目标的生成规则的执行命令不是同一个这可能会可我们带来麻烦不过好在我们可以使用一个自动化变量“$@”(关于自动化变量,将在后面讲述),这个变量表示着目前规则中所有的目标的集合,这样说可能很抽象,还是看一个例子吧。
Makefile的规则中的目标可以不止一个其支持多目标有可能我们的多个目标同时依赖于一个文件并且其生成的命令大体类似。于是我们就能把其合并起来。当然多个目标的生成规则的执行命令不是同一个这可能会可我们带来麻烦不过好在我们可以使用一个自动化变量 ``$@`` (关于自动化变量,将在后面讲述),这个变量表示着目前规则中所有的目标的集合,这样说可能很抽象,还是看一个例子吧。
.. code-block:: makefile
@@ -247,7 +247,7 @@ Makefile的规则中的目标可以不止一个其支持多目标有可能
littleoutput : text.g
generate text.g -little > littleoutput
其中,-$(subst output,,$@)中的“$”表示执行一个Makefile的函数函数名为subst后面的为参数。关于函数将在后面讲述。这里的这个函数是替换字符串的意思“$@”表示目标的集合,就像一个数组,“$@”依次取出目标,并执于命令。
其中, ``-$(subst output,,$@)`` 中的 ``$`` 表示执行一个Makefile的函数函数名为subst后面的为参数。关于函数将在后面讲述。这里的这个函数是替换字符串的意思 ``$@`` 表示目标的集合,就像一个数组, ``$@`` 依次取出目标,并执于命令。
静态模式
--------
@@ -266,9 +266,9 @@ target-parrtern是指明了targets的模式也就是的目标集模式。
prereq-parrterns是目标的依赖模式它对target-parrtern形成的模式再进行一次依赖目标的定义。
这样描述这三个东西,可能还是没有说清楚,还是举个例子来说明一下吧。如果我们的<target-parrtern>定义成“%.o”,意思是我们的<target>;集合中都是以“.o”结尾的,而如果我们的<prereq-parrterns>定义成 “%.c”,意思是对<target-parrtern>所形成的目标集进行二次定义,其计算方法是,取<target-parrtern>模式中的“%”(也就是去掉了[.o]这个结尾),并为其加上[.c]这个结尾,形成的新集合。
这样描述这三个东西,可能还是没有说清楚,还是举个例子来说明一下吧。如果我们的<target-parrtern>定义成 ``%.o`` ,意思是我们的<target>;集合中都是以 ``.o`` 结尾的,而如果我们的<prereq-parrterns>定义成 ``%.c`` ,意思是对<target-parrtern>所形成的目标集进行二次定义,其计算方法是,取<target-parrtern>模式中的 ``%`` (也就是去掉了 ``.o`` 这个结尾),并为其加上 ``.c`` 这个结尾,形成的新集合。
所以,我们的“目标模式”或是“依赖模式”中都应该有“%”这个字符,如果你的文件名中有“%”那么你可以使用反斜杠“\\”进行转义,来标明真实的“%”字符。
所以,我们的“目标模式”或是“依赖模式”中都应该有 ``%`` 这个字符,如果你的文件名中有 ``%`` 那么你可以使用反斜杠 ``\`` 进行转义,来标明真实的 ``%`` 字符。
看一个例子:
@@ -281,7 +281,7 @@ prereq-parrterns是目标的依赖模式它对target-parrtern形成的模式
$(objects): %.o: %.c
$(CC) -c $(CFLAGS) $< -o $@
上面的例子中,指明了我们的目标从$object中获取“%.o”表明要所有以“.o”结尾的目标,也就是foo.o bar.o”,也就是变量$object集合的模式而依赖模式“%.c”则取模式“%.o”的“%”也就是“foo bar”并为其加下“.c”的后缀,于是,我们的依赖目标就是foo.c bar.c”。而命令中的“$<”和“$@”则是自动化变量,“$<”表示所有的依赖目标集(也就是 foo.c bar.c”),“$@”表示目标集也就是“foo.o bar.o”。于是上面的规则展开后等价于下面的规则
上面的例子中,指明了我们的目标从$object中获取 ``%.o`` 表明要所有以 ``.o`` 结尾的目标,也就是 ``foo.o bar.o`` ,也就是变量 ``$object`` 集合的模式,而依赖模式 ``%.c`` 则取模式 ``%.o````%`` ,也就是 ``foo bar`` ,并为其加下 ``.c`` 的后缀,于是,我们的依赖目标就是 ``foo.c bar.c`` 。而命令中的 ``$<````$@`` 则是自动化变量, ``$<`` 表示所有的依赖目标集(也就是 ``foo.c bar.c`` ``$@`` 表示目标集也就是“foo.o bar.o”。于是上面的规则展开后等价于下面的规则
.. code-block:: makefile
@@ -290,7 +290,7 @@ prereq-parrterns是目标的依赖模式它对target-parrtern形成的模式
bar.o : bar.c
$(CC) -c $(CFLAGS) bar.c -o bar.o
试想,如果我们的“%.o”有几百个,那么我们只要用这种很简单的“静态模式规则”就可以写完一堆规则,实在是太有效率了。“静态模式规则”的用法很灵活,如果用得好,那会一个很强大的功能。再看一个例子:
试想,如果我们的 ``%.o`` 有几百个,那么我们只要用这种很简单的“静态模式规则”就可以写完一堆规则,实在是太有效率了。“静态模式规则”的用法很灵活,如果用得好,那会一个很强大的功能。再看一个例子:
.. code-block:: makefile
@@ -306,7 +306,7 @@ $(filter %.o,$(files))表示调用Makefile的filter函数过滤“$files”
自动生成依赖性
--------------
在Makefile中我们的依赖关系可能会需要包含一系列的头文件比如如果我们的main.c中有一句#include "defs.h",那么我们的依赖关系应该是:
在Makefile中我们的依赖关系可能会需要包含一系列的头文件比如如果我们的main.c中有一句 ``#include "defs.h"`` ,那么我们的依赖关系应该是:
.. code-block:: makefile
@@ -324,7 +324,7 @@ $(filter %.o,$(files))表示调用Makefile的filter函数过滤“$files”
main.o : main.c defs.h
于是由编译器自动生成的依赖关系这样一来你就不必再手动书写若干文件的依赖关系而由编译器自动生成了。需要提醒一句的是如果你使用GNU的C/C++编译器,你得用“-MM”参数不然“-M”参数会把一些标准库的头文件也包含进来。
于是由编译器自动生成的依赖关系这样一来你就不必再手动书写若干文件的依赖关系而由编译器自动生成了。需要提醒一句的是如果你使用GNU的C/C++编译器,你得用 ``-MM`` 参数,不然, ``-M`` 参数会把一些标准库的头文件也包含进来。
gcc -M main.c的输出是::
@@ -342,11 +342,11 @@ gcc -MM main.c的输出则是::
main.o: main.c defs.h
那么编译器的这个功能如何与我们的Makefile联系在一起呢。因为这样一来我们的Makefile也要根据这些源文件重新生成让 Makefile自已依赖于源文件这个功能并不现实不过我们可以有其它手段来迂回地实现这一功能。GNU组织建议把编译器为每一个源文件的自动生成的依赖关系放到一个文件中为每一个“name.c”的文件都生成一个“name.d”的Makefile文件[.d]文件中就存放对应[.c]文件的依赖关系。
那么编译器的这个功能如何与我们的Makefile联系在一起呢。因为这样一来我们的Makefile也要根据这些源文件重新生成让 Makefile自已依赖于源文件这个功能并不现实不过我们可以有其它手段来迂回地实现这一功能。GNU组织建议把编译器为每一个源文件的自动生成的依赖关系放到一个文件中为每一个 ``name.c`` 的文件都生成一个 ``name.d`` 的Makefile文件 ``.d`` 文件中就存放对应 ``.c`` 文件的依赖关系。
于是,我们可以写出[.c]文件和[.d]文件的依赖关系并让make自动更新或生成[.d]文件并把其包含在我们的主Makefile中这样我们就可以自动化地生成每个文件的依赖关系了。
于是,我们可以写出 ``.c`` 文件和 ``.d`` 文件的依赖关系并让make自动更新或生成 ``.d`` 文件并把其包含在我们的主Makefile中这样我们就可以自动化地生成每个文件的依赖关系了。
这里,我们给出了一个模式规则来产生[.d]文件:
这里,我们给出了一个模式规则来产生 ``.d`` 文件:
.. code-block:: makefile
@@ -357,9 +357,9 @@ gcc -MM main.c的输出则是::
rm -f $@.$$$$
这个规则的意思是,所有的[.d]文件依赖于[.c]文件,“rm -f $@的意思是删除所有的目标,也就是[.d]文件,第二行的意思是,为每个依赖文件“$<”,也就是[.c]文件生成依赖文件,“$@”表示模式“%.d”文件如果有一个C文件是name.c那么“%”就是 “name”“$$$$”意为一个随机编号第二行生成的文件有可能是“name.d.12345”第三行使用sed命令做了一个替换关于sed命令的用法请参看相关的使用文档。第四行就是删除临时文件。
这个规则的意思是,所有的 ``.d`` 文件依赖于 ``.c`` 文件, ``rm -f $@`` 的意思是删除所有的目标,也就是 ``.d`` 文件,第二行的意思是,为每个依赖文件 ``$<`` ,也就是 ``.c`` 文件生成依赖文件, ``$@`` 表示模式 ``%.d`` 文件如果有一个C文件是name.c那么 ``%`` 就是 ``name`` ``$$$$`` 意为一个随机编号第二行生成的文件有可能是“name.d.12345”第三行使用sed命令做了一个替换关于sed命令的用法请参看相关的使用文档。第四行就是删除临时文件。
总而言之,这个模式要做的事就是在编译器生成的依赖关系中加入[.d]文件的依赖,即把依赖关系:
总而言之,这个模式要做的事就是在编译器生成的依赖关系中加入 ``.d`` 文件的依赖,即把依赖关系:
.. code-block:: makefile
@@ -371,7 +371,7 @@ gcc -MM main.c的输出则是::
main.o main.d : main.c defs.h
于是,我们的[.d]文件也会自动更新了,并会自动生成了,当然,你还可以在这个[.d]文件中加入的不只是依赖关系,包括生成的命令也可一并加入,让每个[.d]文件都包含一个完赖的规则。一旦我们完成这个工作接下来我们就要把这些自动生成的规则放进我们的主Makefile中。我们可以使用Makefile的“include”命令来引入别的Makefile文件前面讲过例如
于是,我们的 ``.d`` 文件也会自动更新了,并会自动生成了,当然,你还可以在这个 ``.d`` 文件中加入的不只是依赖关系,包括生成的命令也可一并加入,让每个 ``.d`` 文件都包含一个完赖的规则。一旦我们完成这个工作接下来我们就要把这些自动生成的规则放进我们的主Makefile中。我们可以使用Makefile的“include”命令来引入别的Makefile文件前面讲过例如
.. code-block:: makefile
@@ -379,4 +379,4 @@ gcc -MM main.c的输出则是::
include $(sources:.c=.d)
上述语句中的$(sources:.c=.d)”中的“.c=.d”的意思是做一个替换,把变量$(sources)所有[.c]的字串都替换成[.d]关于这个“替换”的内容在后面我会有更为详细的讲述。当然你得注意次序因为include是按次来载入文件最先载入的[.d]文件中的目标会成为默认目标。
上述语句中的 ``$(sources:.c=.d)`` 中的 ``.c=.d`` 的意思是做一个替换,把变量 ``$(sources)`` 所有 ``.c`` 的字串都替换成 ``.d`` 关于这个“替换”的内容在后面我会有更为详细的讲述。当然你得注意次序因为include是按次来载入文件最先载入的 ``.d`` 文件中的目标会成为默认目标。