fix rst format

This commit is contained in:
Dongdong Tian
2015-11-09 11:41:27 +08:00
parent c21904a8ae
commit 956141d25f
6 changed files with 250 additions and 250 deletions

View File

@@ -49,7 +49,7 @@ command
insert.o search.o files.o utils.o
cc -o edit main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
main.o : main.c defs.h
cc -c main.c
kbd.o : kbd.c defs.h command.h
@@ -70,32 +70,32 @@ command
rm edit main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
反斜杠(\\是换行符的意思。这样比较便于makefile的易读。我们可以把这个内容保存在名字为“makefile”或“Makefile”的文件中然后在该目录下直接输入命令\ ``make``\ 就可以生成执行文件edit。如果要删除执行文件和所有的中间目标文件那么只要简单地执行一下\ ``make clean``\ 就可以了。
反斜杠( ``\`` 是换行符的意思。这样比较便于makefile的易读。我们可以把这个内容保存在名字为“makefile”或“Makefile”的文件中然后在该目录下直接输入命令 ``make`` 就可以生成执行文件edit。如果要删除执行文件和所有的中间目标文件那么只要简单地执行一下 ``make clean`` 就可以了。
在这个makefile中目标文件target包含执行文件edit和中间目标文件\ ``*.o``\ 依赖文件prerequisites就是冒号后面的那些\ ``.c``\ 文件和\ ``.h``\ 文件。每一个\ ``.o``\ 文件都有一组依赖文件,而这些\ ``.o``\ 文件又是执行文件\ ``edit``\ 的依赖文件。依赖关系的实质就是说明了目标文件是由哪些文件生成的,换言之,目标文件是哪些文件更新的。
在这个makefile中目标文件target包含执行文件edit和中间目标文件 ``*.o`` 依赖文件prerequisites就是冒号后面的那些 ``.c`` 文件和 ``.h`` 文件。每一个 ``.o`` 文件都有一组依赖文件,而这些 ``.o`` 文件又是执行文件 ``edit`` 的依赖文件。依赖关系的实质就是说明了目标文件是由哪些文件生成的,换言之,目标文件是哪些文件更新的。
在定义好依赖关系后,后续的那一行定义了如何生成目标文件的操作系统命令,一定要以一个\ ``Tab``\ 键作为开头。记住make并不管命令是怎么工作的他只管执行所定义的命令。make会比较targets文件和prerequisites文件的修改日期如果prerequisites文件的日期要比targets文件的日期要新或者target不存在的话那么make就会执行后续定义的命令。
在定义好依赖关系后,后续的那一行定义了如何生成目标文件的操作系统命令,一定要以一个 ``Tab`` 键作为开头。记住make并不管命令是怎么工作的他只管执行所定义的命令。make会比较targets文件和prerequisites文件的修改日期如果prerequisites文件的日期要比targets文件的日期要新或者target不存在的话那么make就会执行后续定义的命令。
这里要说明一点的是,clean不是一个文件它只不过是一个动作名字有点像c语言中的lable一样其冒号后什么也没有那么make就不会自动去找它的依赖性也就不会自动执行其后所定义的命令。要执行其后的命令就要在make命令后明显得指出这个lable的名字。这样的方法非常有用我们可以在一个makefile中定义不用的编译或是和编译无关的命令比如程序的打包程序的备份等等。
这里要说明一点的是, ``clean`` 不是一个文件它只不过是一个动作名字有点像c语言中的lable一样其冒号后什么也没有那么make就不会自动去找它的依赖性也就不会自动执行其后所定义的命令。要执行其后的命令就要在make命令后明显得指出这个lable的名字。这样的方法非常有用我们可以在一个makefile中定义不用的编译或是和编译无关的命令比如程序的打包程序的备份等等。
make是如何工作的
----------------
在默认的方式下,也就是我们只输入\ ``make``\ 命令。那么,
在默认的方式下,也就是我们只输入 ``make`` 命令。那么,
#. make会在当前目录下找名字叫“Makefile”或“makefile”的文件。
#. 如果找到它会找文件中的第一个目标文件target在上面的例子中他会找到“edit”这个文件并把这个文件作为最终的目标文件。
#. 如果edit文件不存在或是edit所依赖的后面的\ ``.o``\ 文件的文件修改时间要比\ ``edit``\ 这个文件新,那么,他就会执行后面所定义的命令来生成\ ``edit``\ 这个文件。
#. 如果\ ``edit``\ 所依赖的\ ``.o``\ 文件也不存在那么make会在当前文件中找目标为\ ``.o``\ 文件的依赖性,如果找到则再根据那一个规则生成\ ``.o``\ 文件。(这有点像一个堆栈的过程)
#. 当然你的C文件和H文件是存在的啦于是make会生成\ ``.o``\ 文件,然后再用\ ``.o``\ 文件生成make的终极任务也就是执行文件\ ``edit``\ 了。
#. make会在当前目录下找名字叫“Makefile”或“makefile”的文件。
#. 如果找到它会找文件中的第一个目标文件target在上面的例子中他会找到“edit”这个文件并把这个文件作为最终的目标文件。
#. 如果edit文件不存在或是edit所依赖的后面的 ``.o`` 文件的文件修改时间要比 ``edit`` 这个文件新,那么,他就会执行后面所定义的命令来生成 ``edit`` 这个文件。
#. 如果 ``edit`` 所依赖的 ``.o`` 文件也不存在那么make会在当前文件中找目标为 ``.o`` 文件的依赖性,如果找到则再根据那一个规则生成 ``.o`` 文件。(这有点像一个堆栈的过程)
#. 当然你的C文件和H文件是存在的啦于是make会生成 ``.o`` 文件,然后再用 ``.o`` 文件生成make的终极任务也就是执行文件 ``edit`` 了。
这就是整个make的依赖性make会一层又一层地去找文件的依赖关系直到最终编译出第一个目标文件。在找寻的过程中如果出现错误比如最后被依赖的文件找不到那么make就会直接退出并报错而对于所定义的命令的错误或是编译不成功make根本不理。make只管文件的依赖性如果在我找了依赖关系之后冒号后面的文件还是不在那么对不起我就不工作啦。
这就是整个make的依赖性make会一层又一层地去找文件的依赖关系直到最终编译出第一个目标文件。在找寻的过程中如果出现错误比如最后被依赖的文件找不到那么make就会直接退出并报错而对于所定义的命令的错误或是编译不成功make根本不理。make只管文件的依赖性如果在我找了依赖关系之后冒号后面的文件还是不在那么对不起我就不工作啦。
通过上述分析我们知道像clean这种没有被第一个目标文件直接或间接关联那么它后面所定义的命令将不会被自动执行不过我们可以显示要make执行。即命令——\ ``make clean``\ ,以此来清除所有的目标文件,以便重编译。
通过上述分析我们知道像clean这种没有被第一个目标文件直接或间接关联那么它后面所定义的命令将不会被自动执行不过我们可以显示要make执行。即命令—— ``make clean`` ,以此来清除所有的目标文件,以便重编译。
于是在我们编程中,如果这个工程已被编译过了,当我们修改了其中一个源文件,比如\ ``file.c``\ ,那么根据我们的依赖性,我们的目标\ ``file.o``\ 会被重编译(也就是在这个依性关系后面所定义的命令),于是\ ``file.o``\ 的文件也是最新的啦,于是\ ``file.o``\ 的文件修改时间要比\ ``edit``\ 要新,所以\ ``edit``\ 也会被重新链接了(详见\ ``edit``\ 目标文件后定义的命令)。
于是在我们编程中,如果这个工程已被编译过了,当我们修改了其中一个源文件,比如 ``file.c`` ,那么根据我们的依赖性,我们的目标 ``file.o`` 会被重编译(也就是在这个依性关系后面所定义的命令),于是 ``file.o`` 的文件也是最新的啦,于是 ``file.o`` 的文件修改时间要比 ``edit`` 要新,所以 ``edit`` 也会被重新链接了(详见 ``edit`` 目标文件后定义的命令)。
而如果我们改变了\ ``command.h``\ ,那么,\ ``kdb.o``\ 、\ ``command.o``\ 和\ ``files.o``\ 都会被重编译,并且,\ ``edit``\ 会被重链接。
而如果我们改变了 ``command.h`` ,那么, ``kdb.o````command.o````files.o`` 都会被重编译,并且, ``edit`` 会被重链接。
makefile中使用变量
------------------
@@ -109,22 +109,22 @@ makefile中使用变量
cc -o edit main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
我们可以看到\ ``.o``\ 文件的字符串被重复了两次,如果我们的工程需要加入一个新的\ ``.o``\ 文件那么我们需要在两个地方加应该是三个地方还有一个地方在clean中。当然我们的makefile并不复杂所以在两个地方加也不累但如果makefile变得复杂那么我们就有可能会忘掉一个需要加入的地方而导致编译失败。所以为了makefile的易维护在makefile中我们可以使用变量。makefile的变量也就是一个字符串理解成C语言中的宏可能会更好。
我们可以看到 ``.o`` 文件的字符串被重复了两次,如果我们的工程需要加入一个新的 ``.o`` 文件那么我们需要在两个地方加应该是三个地方还有一个地方在clean中。当然我们的makefile并不复杂所以在两个地方加也不累但如果makefile变得复杂那么我们就有可能会忘掉一个需要加入的地方而导致编译失败。所以为了makefile的易维护在makefile中我们可以使用变量。makefile的变量也就是一个字符串理解成C语言中的宏可能会更好。
比如,我们声明一个变量,叫\ ``objects``\ \ ``OBJECTS``\ \ ``objs``\ \ ``OBJS``\\ ``obj``\ 或是\ ``OBJ``\反正不管什么啦只要能够表示obj文件就行了。我们在makefile一开始就这样定义
比如,我们声明一个变量,叫 ``objects`` ``OBJECTS`` ``objs`` ``OBJS``\ ``obj`` 或是 ``OBJ``\反正不管什么啦只要能够表示obj文件就行了。我们在makefile一开始就这样定义
.. code-block:: makefile
objects = main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
于是我们就可以很方便地在我们的makefile中以\ ``$(objects)``\ 的方式来使用这个变量了于是我们的改良版makefile就变成下面这个样子
于是我们就可以很方便地在我们的makefile中以 ``$(objects)`` 的方式来使用这个变量了于是我们的改良版makefile就变成下面这个样子
.. code-block:: makefile
objects = main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
edit : $(objects)
cc -o edit $(objects)
main.o : main.c defs.h
@@ -146,25 +146,25 @@ makefile中使用变量
clean :
rm edit $(objects)
于是如果有新的\ ``.o``\ 文件加入,我们只需简单地修改一下\ ``objects``\ 变量就可以了。
于是如果有新的 ``.o`` 文件加入,我们只需简单地修改一下 ``objects`` 变量就可以了。
关于变量更多的话题,我会在后续给你一一道来。
让make自动推导
--------------
GNU的make很强大它可以自动推导文件以及文件依赖关系后面的命令于是我们就没必要去在每一个\ ``.o``\ 文件后都写上类似的命令因为我们的make会自动识别并自己推导命令。
GNU的make很强大它可以自动推导文件以及文件依赖关系后面的命令于是我们就没必要去在每一个 ``.o`` 文件后都写上类似的命令因为我们的make会自动识别并自己推导命令。
只要make看到一个\ ``.o``\ 文件,它就会自动的把\ ``.c``\ 文件加在依赖关系中如果make找到一个\ ``whatever.o``\ ,那么\ ``whatever.c``\ ,就会是\ ``whatever.o``\ 的依赖文件。并且\ ``cc -c whatever.c``\ 也会被推导出来于是我们的makefile再也不用写得这么复杂。我们的新makefile又出炉了。
只要make看到一个 ``.o`` 文件,它就会自动的把 ``.c`` 文件加在依赖关系中如果make找到一个 ``whatever.o`` ,那么 ``whatever.c`` ,就会是 ``whatever.o`` 的依赖文件。并且 ``cc -c whatever.c`` 也会被推导出来于是我们的makefile再也不用写得这么复杂。我们的新makefile又出炉了。
.. code-block:: makefile
objects = main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
edit : $(objects)
cc -o edit $(objects)
main.o : defs.h
kbd.o : defs.h command.h
command.o : defs.h command.h
@@ -173,7 +173,7 @@ GNU的make很强大它可以自动推导文件以及文件依赖关系后面
search.o : defs.h buffer.h
files.o : defs.h buffer.h command.h
utils.o : defs.h
.PHONY : clean
clean :
rm edit $(objects)
@@ -185,16 +185,16 @@ GNU的make很强大它可以自动推导文件以及文件依赖关系后面
另类风格的makefiles
-------------------
既然我们的make可以自动推导命令那么我看到那堆\ ``.o``\ 和\ ``.h``\ 的依赖就有点不爽,那么多的重复的\ ``.h``\ 能不能把其收拢起来好吧没有问题这个对于make来说很容易谁叫它提供了自动推导命令和文件的功能呢来看看最新风格的makefile吧。
既然我们的make可以自动推导命令那么我看到那堆 ``.o````.h`` 的依赖就有点不爽,那么多的重复的 ``.h`` 能不能把其收拢起来好吧没有问题这个对于make来说很容易谁叫它提供了自动推导命令和文件的功能呢来看看最新风格的makefile吧。
.. code-block:: makefile
objects = main.o kbd.o command.o display.o \
insert.o search.o files.o utils.o
edit : $(objects)
cc -o edit $(objects)
$(objects) : defs.h
kbd.o command.o files.o : command.h
display.o insert.o search.o files.o : buffer.h
@@ -203,12 +203,12 @@ GNU的make很强大它可以自动推导文件以及文件依赖关系后面
clean :
rm edit $(objects)
这种风格让我们的makefile变得很简单但我们的文件依赖关系就显得有点凌乱了。鱼和熊掌不可兼得。还看你的喜好了。我是不喜欢这种风格的一是文件的依赖关系看不清楚二是如果文件一多要加入几个新的\ ``.o``\ 文件,那就理不清楚了。
这种风格让我们的makefile变得很简单但我们的文件依赖关系就显得有点凌乱了。鱼和熊掌不可兼得。还看你的喜好了。我是不喜欢这种风格的一是文件的依赖关系看不清楚二是如果文件一多要加入几个新的 ``.o`` 文件,那就理不清楚了。
清空目标文件的规则
------------------
每个Makefile中都应该写一个清空目标文件\ ``.o``\ 和执行文件)的规则,这不仅便于重编译,也很利于保持文件的清洁。这是一个“修养”(呵呵,还记得我的《编程修养》吗)。一般的风格都是:
每个Makefile中都应该写一个清空目标文件 ``.o`` 和执行文件)的规则,这不仅便于重编译,也很利于保持文件的清洁。这是一个“修养”(呵呵,还记得我的《编程修养》吗)。一般的风格都是:
.. code-block:: makefile
@@ -230,27 +230,27 @@ GNU的make很强大它可以自动推导文件以及文件依赖关系后面
Makefile里有什么
------------------
Makefile里主要包含了五个东西显式规则、隐晦规则、变量定义、文件指示和注释。
Makefile里主要包含了五个东西显式规则、隐晦规则、变量定义、文件指示和注释。
#. 显式规则。显式规则说明了如何生成一个或多个目标文件。这是由Makefile的书写者明显指出要生成的文件文件的依赖文件生成的命令。
#. 隐晦规则。由于我们的make有自动推导的功能所以隐晦的规则可以让我们比较简略地书写Makefile这是由make所支持的。
#. 变量的定义。在Makefile中我们要定义一系列的变量变量一般都是字符串这个有点像你C语言中的宏当Makefile被执行时其中的变量都会被扩展到相应的引用位置上。
#. 文件指示。其包括了三个部分一个是在一个Makefile中引用另一个Makefile就像C语言中的include一样另一个是指根据某些情况指定Makefile中的有效部分就像C语言中的预编译#if一样还有就是定义一个多行的命令。有关这一部分的内容我会在后续的部分中讲述。
#. 注释。Makefile中只有行注释和UNIX的Shell脚本一样其注释是用“#”字符这个就像C/C++中的“//”一样。如果你要在你的Makefile中使用“#”字符,可以用反斜框进行转义,如:\ ``\#``\
#. 显式规则。显式规则说明了如何生成一个或多个目标文件。这是由Makefile的书写者明显指出要生成的文件文件的依赖文件生成的命令。
#. 隐晦规则。由于我们的make有自动推导的功能所以隐晦的规则可以让我们比较简略地书写Makefile这是由make所支持的。
#. 变量的定义。在Makefile中我们要定义一系列的变量变量一般都是字符串这个有点像你C语言中的宏当Makefile被执行时其中的变量都会被扩展到相应的引用位置上。
#. 文件指示。其包括了三个部分一个是在一个Makefile中引用另一个Makefile就像C语言中的include一样另一个是指根据某些情况指定Makefile中的有效部分就像C语言中的预编译#if一样还有就是定义一个多行的命令。有关这一部分的内容我会在后续的部分中讲述。
#. 注释。Makefile中只有行注释和UNIX的Shell脚本一样其注释是用“#”字符这个就像C/C++中的“//”一样。如果你要在你的Makefile中使用“#”字符,可以用反斜框进行转义,如: ``\#``
最后还值得一提的是在Makefile中的命令必须要以\ ``Tab``\ 键开始。
最后还值得一提的是在Makefile中的命令必须要以 ``Tab`` 键开始。
Makefile的文件名
----------------
默认的情况下make命令会在当前目录下按顺序找寻文件名为“GNUmakefile”、“makefile”、“Makefile”的文件找到了解释这个文件。在这三个文件名中最好使用“Makefile”这个文件名因为这个文件名第一个字符为大写这样有一种显目的感觉。最好不要用“GNUmakefile”这个文件是GNU的make识别的。有另外一些make只对全小写的“makefile”文件名敏感但是基本上来说大多数的make都支持“makefile”和“Makefile”这两种默认文件名。
当然你可以使用别的文件名来书写Makefile比如“Make.Linux”“Make.Solaris”“Make.AIX”等如果要指定特定的Makefile你可以使用make的\ ``-f``\ 和\ ``--file``\ 参数,如:\ ``make -f Make.Linux``\ 或\ ``make --file Make.AIX``\
当然你可以使用别的文件名来书写Makefile比如“Make.Linux”“Make.Solaris”“Make.AIX”等如果要指定特定的Makefile你可以使用make的 ``-f````--file`` 参数,如: ``make -f Make.Linux````make --file Make.AIX``
引用其它的Makefile
------------------
在Makefile使用include关键字可以把别的Makefile包含进来这很像C语言的#include被包含的文件会原模原样的放在当前文件的包含位置。include的语法是
在Makefile使用include关键字可以把别的Makefile包含进来这很像C语言的#include被包含的文件会原模原样的放在当前文件的包含位置。include的语法是
.. code-block:: makefile
@@ -258,24 +258,24 @@ Makefile的文件名
filename可以是当前操作系统Shell的文件模式可以包含路径和通配符
在include前面可以有一些空字符但是绝不能是\ ``Tab``\ 键开始。\ ``include``\ 和\ ``<filename>;``\ 可以用一个或多个空格隔开。举个例子你有这样几个Makefilea.mk、b.mk、c.mk还有一个文件叫foo.make以及一个变量$(bar)其包含了e.mk和f.mk那么下面的语句
在include前面可以有一些空字符但是绝不能是 ``Tab`` 键开始。 ``include````<filename>;`` 可以用一个或多个空格隔开。举个例子你有这样几个Makefilea.mk、b.mk、c.mk还有一个文件叫foo.make以及一个变量$(bar)其包含了e.mk和f.mk那么下面的语句
.. code-block:: makefile
include foo.make *.mk $(bar)
等价于:
等价于:
.. code-block:: makefile
include foo.make a.mk b.mk c.mk e.mk f.mk
make命令开始时会找寻include所指出的其它Makefile并把其内容安置在当前的位置。就好像C/C++的#include指令一样。如果文件都没有指定绝对路径或是相对路径的话make会在当前目录下首先寻找如果当前目录下没有找到那么make还会在下面的几个目录下找
make命令开始时会找寻include所指出的其它Makefile并把其内容安置在当前的位置。就好像C/C++的#include指令一样。如果文件都没有指定绝对路径或是相对路径的话make会在当前目录下首先寻找如果当前目录下没有找到那么make还会在下面的几个目录下找
#. 如果make执行时有“\ ``-I``\ ”或“\ ``--include-dir``\ ”参数那么make就会在这个参数所指定的目录下去寻找。
#. 如果make执行时有“ ``-I`` ”或“ ``--include-dir`` ”参数那么make就会在这个参数所指定的目录下去寻找。
#. 如果目录<prefix>/include一般是/usr/local/bin或/usr/include存在的话make也会去找。
如果有文件没有找到的话make会生成一条警告信息但不会马上出现致命错误。它会继续载入其它的文件一旦完成makefile的读取make会再重试这些没有找到或是不能读取的文件如果还是不行make才会出现一条致命信息。如果你想让make不理那些无法读取的文件而继续执行你可以在include前加一个减号“-”。如:
如果有文件没有找到的话make会生成一条警告信息但不会马上出现致命错误。它会继续载入其它的文件一旦完成makefile的读取make会再重试这些没有找到或是不能读取的文件如果还是不行make才会出现一条致命信息。如果你想让make不理那些无法读取的文件而继续执行你可以在include前加一个减号“-”。如:
.. code-block:: makefile