[关闭]
@cyysu 2017-10-18T08:44:33.000000Z 字数 10864 阅读 877

Makefile-项目篇（一）

  • 时间：2017年10月10日
  • 作者：Kali
  • 邮箱：cyysu.github.io@gmail.com
  • 版本：3.0
  • 描述：Makefile调用shell实战

Makefile系列教程

基础准备

  1. # 在Makefile中调用shell时需要注意一个完整的shell命令必须在一行内写完，或者采用"\"进行连接，并且每一个完毕的shell采用";"结尾，同时建议所有变量书写格式为“xxx=xxx”, 等号两边没有空格。
  2. # 下面我们来看几个栗子:
  3. mj@DZ:~/桌面/makefile/my$ cat Makefile 
  4. DIR=./
  5. .PHONY: all
  6. all:
  7. 	@for i in `ls $(DIR)`;do \
  8. 		echo $$i; \
  9. 	done
  10. 	@echo ${MAKE}
  12. # 执行效果
  13. mj@DZ:~/桌面/makefile/my$ make
  14. foo.o
  15. main
  16. main.c
  17. main.o
  18. Makefile
  19. test.c
  20. make
  22. # 如果一个shell命令过长，那么我们可以采用命令定义和执行分开模式，我们来改写一下上面的格式：
  23. DIR=./
  24. shellcmd = @for i in `ls $(DIR)`;do \
  25.                 echo $$i; \
  26.             done
  27. .PHONY: test
  28. test:
  29.     $(shellcmd)
  31. all:
  32.     @echo ${MAKE}
  34. # 还有就是shell的传递变量问题，如果时一个$符号，传递的是Makefile中的变量，如果时两个$$，那么传递的是shell中的变量，可以看下面的栗子
  35. DIR=./
  36. shellDateCmd=`date "+%Y-%m-%d %H:%M:%S"`
  37. shellShowDirCmd=@for i in `ls $(DIR)`;do \
  38. 					echo $$i; \
  39. 				 done
  40. data=1
  41. .PHONY: vari
  42. vari:
  43. 	@echo "当前时间为:" $(shellDateCmd);
  44.     @echo "data value = " ${data};
  45. 	# 这里表示是一个shell
  46. 	@data=2; 
  47. 	# 这里输出的是Makefile中的变量
  48. 	@echo ${data};
  49.     # 这里输出的时shell中的变量
  50.     @echo $${data};
  51. test:
  52.     $(shellShowDirCmd)
  53. all:
  54.     @echo ${MAKE}
  56. # 执行结果，可以看到最后一行输出为空，表示我们建立的这个shell中时没有data这个变量的
  57. mj@DZ:~/桌面/makefile/my$ make
  58. 当前时间为: 2017-10-10 16:24:57
  59. data value =  1
  60. 1
  62. mj@DZ:~/桌面/makefile/my$ 
  65. # 再来一个栗子，我们改写上面的栗子
  66. DIR=./
  68. shellDateCmd=`date "+%Y-%m-%d %H:%M:%S"`
  70. shellShowDirCmd=@for i in `ls $(DIR)`;do \
  71.                     echo $$i; \
  72.                  done
  73. data=1
  75. .PHONY: shellvari
  77. shellvari:
  78.     @echo "当前时间为:" $(shellDateCmd);
  79. 	@echo "data value = " ${data};
  80.     @data=2; \
  81.     echo ${data}; \
  82.     echo $${data}; 
  84. vari:
  85.     @echo "当前时间为:" $(shellDateCmd);
  86. 	@echo "data value = " ${data};
  87.     @data=2; 
  88.     @echo ${data};
  89.     @echo $${data};
  91. test:
  92.     $(shellShowDirCmd)
  94. all:
  95.     @echo ${MAKE}
  97. # 执行结果，一开始data为1，这个原因就不多说了。从data=2之后用“\”连接，那么这里表示时一个shell，也就是shell中的data此时数值为2，但是这个命令echo ${data}; \输出的是Makefile中的变量,echo $${data};这个才是输出的shell中的变量
  98. mj@DZ:~/桌面/makefile/my$ make
  99. 当前时间为: 2017-10-10 16:29:30
  100. data value =  1
  101. 1
  102. 2
  103. mj@DZ:~/桌面/makefile/my$

项目实战

项目来源于：https://github.com/cyysu/sphinx.git

  1. # 我在这里选择了一个文档生成工具Sphinx的Makefile来作为本次项目实战教程
  2. # 纵观整个Makefile，正好我们的基础篇和项目篇面大部分内容都涉及到了，没有涉及到的内容我就会在文中给出注释。
  3. # Makefile for Sphinx documentation
  5. # 
  6. # You can set these variables from the command line.
  7. SPHINXOPTS    =
  8. SPHINXBUILD   = sphinx-build
  9. PAPER         =
  10. BUILDDIR      = build
  12. # ifeq为Makefile内置函数，作用和C语言中的if语句一致，可以看到这里的shell语句也是连成一句话的
  13. # User-friendly check for sphinx-build
  14. ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
  15. $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
  16. endif
  18. # 这里的 -D 表示时一个宏定义 -d是sphinx设置输出目标目录
  19. # Internal variables.
  20. PAPEROPT_a4     = -D latex_paper_size=a4
  21. PAPEROPT_letter = -D latex_paper_size=letter
  22. ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
  23. # the i18n builder cannot share the environment and doctrees with the others
  24. I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
  26. # 设置伪目标 剩下的内容都差不多，就不做过多的介绍了，看完了这里有没有感觉这么长的东西其实看起来也是蛮简单的啊！
  27. .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
  29. help:
  30.     # 增加@不会回显命令
  31.     @echo "Please use \`make <target>' where <target> is one of"
  32.     @echo "  html       to make standalone HTML files"
  33.     @echo "  dirhtml    to make HTML files named index.html in directories"
  34.     @echo "  singlehtml to make a single large HTML file"
  35.     @echo "  pickle     to make pickle files"
  36.     @echo "  json       to make JSON files"
  37.     @echo "  htmlhelp   to make HTML files and a HTML help project"
  38.     @echo "  qthelp     to make HTML files and a qthelp project"
  39.     @echo "  applehelp  to make an Apple Help Book"
  40.     @echo "  devhelp    to make HTML files and a Devhelp project"
  41.     @echo "  epub       to make an epub"
  42.     @echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
  43.     @echo "  latexpdf   to make LaTeX files and run them through pdflatex"
  44.     @echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
  45.     @echo "  text       to make text files"
  46.     @echo "  man        to make manual pages"
  47.     @echo "  texinfo    to make Texinfo files"
  48.     @echo "  info       to make Texinfo files and run them through makeinfo"
  49.     @echo "  gettext    to make PO message catalogs"
  50.     @echo "  changes    to make an overview of all changed/added/deprecated items"
  51.     @echo "  xml        to make Docutils-native XML files"
  52.     @echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
  53.     @echo "  linkcheck  to check all external links for integrity"
  54.     @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
  55.     @echo "  coverage   to run coverage check of the documentation (if enabled)"
  57. clean:
  58.     rm -rf $(BUILDDIR)/*
  60. html:
  61.     $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
  62. 	@echo
  63. 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
  65. dirhtml:
  66.     $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
  67. 	@echo
  68. 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
  70. singlehtml:
  71.     $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
  72. 	@echo
  73. 	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
  75. pickle:
  76.     $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
  77.     @echo
  78.     @echo "Build finished; now you can process the pickle files."
  80. json:
  81.     $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
  82.     @echo
  83.     @echo "Build finished; now you can process the JSON files."
  85. htmlhelp:
  86.     $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
  87. 	@echo
  88. 	@echo "Build finished; now you can run HTML Help Workshop with the" \
  89. 	      ".hhp project file in $(BUILDDIR)/htmlhelp."
  91. qthelp:
  92.     $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
  93. 	@echo
  94. 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
  95. 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
  96.     @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Python-OperSource-Project-Developer-Guide.qhcp"
  97. 	@echo "To view the help file:"
  98. 	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Python-OperSource-Project-Developer-Guide.qhc"
  100. applehelp:
  101.     $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
  102. 	@echo
  103. 	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
  104.     @echo "N.B. You won't be able to view it unless you put it in" \
  105.           "~/Library/Documentation/Help or install it in your application" \
  106.           "bundle."
  108. devhelp:
  109.     $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
  110. 	@echo
  111. 	@echo "Build finished."
  112. 	@echo "To view the help file:"
  113. 	@echo "# mkdir -p $$HOME/.local/share/devhelp/Python-OperSource-Project-Developer-Guide"
  114. 	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Python-OperSource-Project-Developer-Guide"
  115.     @echo "# devhelp"
  117. epub:
  118.     $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
  119. 	@echo
  120. 	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
  122. latex:
  123.     $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  124. 	@echo
  125. 	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
  126.     @echo "Run \`make' in that directory to run these through (pdf)latex" \
  127.           "(use \`make latexpdf' here to do that automatically)."
  129. latexpdf:
  130.     $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  131. 	@echo "Running LaTeX files through pdflatex..."
  132. 	$(MAKE) -C $(BUILDDIR)/latex all-pdf
  133. 	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
  135. latexpdfja:
  136.     $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
  137. 	@echo "Running LaTeX files through platex and dvipdfmx..."
  138. 	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
  139. 	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
  141. text:
  142.     $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
  143. 	@echo
  144. 	@echo "Build finished. The text files are in $(BUILDDIR)/text."
  146. man:
  147.     $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
  148. 	@echo
  149. 	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
  151. texinfo:
  152.     $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
  153. 	@echo
  154. 	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
  155.     @echo "Run \`make' in that directory to run these through makeinfo" \
  156.           "(use \`make info' here to do that automatically)."
  158. info:
  159.     $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
  160. 	@echo "Running Texinfo files through makeinfo..."
  161. 	make -C $(BUILDDIR)/texinfo info
  162.     @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
  164. gettext:
  165.     $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
  166. 	@echo
  167. 	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
  169. changes:
  170.     $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
  171. 	@echo
  172. 	@echo "The overview file is in $(BUILDDIR)/changes."
  174. linkcheck:
  175.     $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
  176. 	@echo
  177. 	@echo "Link check complete; look for any errors in the above output " \
  178. 	      "or in $(BUILDDIR)/linkcheck/output.txt."
  180. doctest:
  181.     $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
  182. 	@echo "Testing of doctests in the sources finished, look at the " \
  183. 	      "results in $(BUILDDIR)/doctest/output.txt."
  185. coverage:
  186.     $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
  187. 	@echo "Testing of coverage in the sources finished, look at the " \
  188. 	      "results in $(BUILDDIR)/coverage/python.txt."
  190. xml:
  191.     $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
  192. 	@echo
  193. 	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
  195. pseudoxml:
  196.     $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
  197. 	@echo
  198. 	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

实战运行演示

  1. # sphinx-build安装成功之后的情况
  2. mj@DZ:~/桌面/Linux/Python-OpenSource-Project-Developer-Guide$ sphinx-build --version
  3. Sphinx (sphinx-build) 1.6.4
  5. # 如果你的系统没有，那么执行下面程序
  6. mj@DZ:~/桌面/Linux/Python-OpenSource-Project-Developer-Guide$ sudo easy_install sphinx
  7. Searching for sphinx
  8. Best match: Sphinx 1.6.4
  9. Adding Sphinx 1.6.4 to easy-install.pth file
  10. Installing sphinx-apidoc script to /usr/local/bin
  11. Installing sphinx-build script to /usr/local/bin
  12. Installing sphinx-quickstart script to /usr/local/bin
  13. Installing sphinx-autogen script to /usr/local/bin
  15. Using /usr/local/lib/python2.7/dist-packages
  16. Processing dependencies for sphinx
  17. Finished processing dependencies for sphinx
  19. #或者使用pip安装
  20. mj@DZ:~/桌面/Linux/Python-OpenSource-Project-Developer-Guide$ pip install sphinx
  21. Requirement already satisfied: sphinx in /usr/local/lib/python2.7/dist-packages
  22. Requirement already satisfied: sphinxcontrib-websupport in /usr/local/lib/python2.7/dist-packages (from sphinx)
  23. Requirement already satisfied: six>=1.5 in /usr/lib/python2.7/dist-packages (from sphinx)
  24. Requirement already satisfied: requests>=2.0.0 in /usr/local/lib/python2.7/dist-packages (from sphinx)
  25. Requirement already satisfied: docutils>=0.11 in /usr/local/lib/python2.7/dist-packages (from sphinx)
  26. Requirement already satisfied: typing; python_version < "3.5" in /usr/local/lib/python2.7/dist-packages (from sphinx)
  27. Requirement already satisfied: Pygments>=2.0 in /usr/local/lib/python2.7/dist-packages (from sphinx)
  28. Requirement already satisfied: setuptools in /usr/local/lib/python2.7/dist-packages/setuptools-33.1.1-py2.7.egg (from sphinx)
  29. Requirement already satisfied: imagesize in /usr/local/lib/python2.7/dist-packages (from sphinx)
  30. Requirement already satisfied: babel!=2.0,>=1.3 in /usr/local/lib/python2.7/dist-packages (from sphinx)
  31. Requirement already satisfied: snowballstemmer>=1.1 in /usr/local/lib/python2.7/dist-packages (from sphinx)
  32. Requirement already satisfied: Jinja2>=2.3 in /usr/local/lib/python2.7/dist-packages (from sphinx)
  33. Requirement already satisfied: alabaster<0.8,>=0.7 in /usr/local/lib/python2.7/dist-packages (from sphinx)
  34. Requirement already satisfied: idna<2.6,>=2.5 in /usr/local/lib/python2.7/dist-packages (from requests>=2.0.0->sphinx)
  35. Requirement already satisfied: chardet<3.1.0,>=3.0.2 in /usr/local/lib/python2.7/dist-packages (from requests>=2.0.0->sphinx)
  36. Requirement already satisfied: certifi>=2017.4.17 in /usr/local/lib/python2.7/dist-packages (from requests>=2.0.0->sphinx)
  37. Requirement already satisfied: urllib3<1.23,>=1.21.1 in /usr/local/lib/python2.7/dist-packages (from requests>=2.0.0->sphinx)
  38. Requirement already satisfied: pytz>=0a in /usr/local/lib/python2.7/dist-packages (from babel!=2.0,>=1.3->sphinx)
  39. Requirement already satisfied: MarkupSafe>=0.23 in /usr/local/lib/python2.7/dist-packages (from Jinja2>=2.3->sphinx)

演示Demo

演示Demo

打赏

                    支付宝                                                         微信

微信与支付宝支付

添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注