PageRenderTime 45ms CodeModel.GetById 20ms RepoModel.GetById 1ms app.codeStats 0ms

/autotools/automake.html_node/Third_002dParty-Makefiles.html

https://gitlab.com/Gentio/my-pdf
HTML | 272 lines | 216 code | 15 blank | 41 comment | 0 complexity | 379940b4930b6e7ff55ed072cfb890ef MD5 | raw file
    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <html>
    3. 

  3. <!-- 
    4. 

  4. This manual is for GNU Automake (version 1.15,
    5. 

  5. 31 December 2014), a program that creates GNU standards-compliant
    6. 

  6. Makefiles from template files.
    7. 

  7. 

  8. Copyright (C) 1995-2014 Free Software Foundation, Inc.
    9. 

  9. 

  10. Permission is granted to copy, distribute and/or modify this document
    11. 

  11. under the terms of the GNU Free Documentation License,
    12. 

  12. Version 1.3 or any later version published by the Free Software
    13. 

  13. Foundation; with no Invariant Sections, with no Front-Cover texts,
    14. 

  14. and with no Back-Cover Texts.  A copy of the license is included in the
    15. 

  15. section entitled "GNU Free Documentation License."
    16. 

  16.  -->
    17. 

  17. <!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
    18. 

  18. <head>
    19. 

  19. <title>automake: Third-Party Makefiles</title>
    20. 

  20. 

  21. <meta name="description" content="automake: Third-Party Makefiles">
    22. 

  22. <meta name="keywords" content="automake: Third-Party Makefiles">
    23. 

  23. <meta name="resource-type" content="document">
    24. 

  24. <meta name="distribution" content="global">
    25. 

  25. <meta name="Generator" content="makeinfo">
    26. 

  26. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    27. 

  27. <link href="index.html#Top" rel="start" title="Top">
    28. 

  28. <link href="Indices.html#Indices" rel="index" title="Indices">
    29. 

  29. <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
    30. 

  30. <link href="Not-Enough.html#Not-Enough" rel="up" title="Not Enough">
    31. 

  31. <link href="Distributing.html#Distributing" rel="next" title="Distributing">
    32. 

  32. <link href="Extending.html#Extending" rel="prev" title="Extending">
    33. 

  33. <style type="text/css">
    34. 

  34. <!--
    35. 

  35. a.summary-letter {text-decoration: none}
    36. 

  36. blockquote.smallquotation {font-size: smaller}
    37. 

  37. div.display {margin-left: 3.2em}
    38. 

  38. div.example {margin-left: 3.2em}
    39. 

  39. div.indentedblock {margin-left: 3.2em}
    40. 

  40. div.lisp {margin-left: 3.2em}
    41. 

  41. div.smalldisplay {margin-left: 3.2em}
    42. 

  42. div.smallexample {margin-left: 3.2em}
    43. 

  43. div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
    44. 

  44. div.smalllisp {margin-left: 3.2em}
    45. 

  45. kbd {font-style:oblique}
    46. 

  46. pre.display {font-family: inherit}
    47. 

  47. pre.format {font-family: inherit}
    48. 

  48. pre.menu-comment {font-family: serif}
    49. 

  49. pre.menu-preformatted {font-family: serif}
    50. 

  50. pre.smalldisplay {font-family: inherit; font-size: smaller}
    51. 

  51. pre.smallexample {font-size: smaller}
    52. 

  52. pre.smallformat {font-family: inherit; font-size: smaller}
    53. 

  53. pre.smalllisp {font-size: smaller}
    54. 

  54. span.nocodebreak {white-space:nowrap}
    55. 

  55. span.nolinebreak {white-space:nowrap}
    56. 

  56. span.roman {font-family:serif; font-weight:normal}
    57. 

  57. span.sansserif {font-family:sans-serif; font-weight:normal}
    58. 

  58. ul.no-bullet {list-style: none}
    59. 

  59. -->
    60. 

  60. </style>
    61. 

  61. 

  62. 

  63. </head>
    64. 

  64. 

  65. <body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
    66. 

  66. <a name="Third_002dParty-Makefiles"></a>
    67. 

  67. <div class="header">
    68. 

  68. <p>
    69. 

  69. Previous: <a href="Extending.html#Extending" accesskey="p" rel="prev">Extending</a>, Up: <a href="Not-Enough.html#Not-Enough" accesskey="u" rel="up">Not Enough</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Indices.html#Indices" title="Index" rel="index">Index</a>]</p>
    70. 

  70. </div>
    71. 

  71. <hr>
    72. 

  72. <a name="Third_002dParty-Makefiles-1"></a>
    73. 

  73. <h3 class="section">23.2 Third-Party <samp>Makefile</samp>s</h3>
    74. 

  74. 

  75. <a name="index-Third_002dparty-packages_002c-interfacing-with"></a>
    76. 

  76. <a name="index-Interfacing-with-third_002dparty-packages"></a>
    77. 

  77. 

  78. <p>In most projects all <samp>Makefile</samp>s are generated by Automake.  In
    79. 

  79. some cases, however, projects need to embed subdirectories with
    80. 

  80. handwritten <samp>Makefile</samp>s.  For instance, one subdirectory could be
    81. 

  81. a third-party project with its own build system, not using Automake.
    82. 

  82. </p>
    83. 

  83. <p>It is possible to list arbitrary directories in <code>SUBDIRS</code> or
    84. 

  84. <code>DIST_SUBDIRS</code> provided each of these directories has a
    85. 

  85. <samp>Makefile</samp> that recognizes all the following recursive targets.
    86. 

  86. </p>
    87. 

  87. <a name="index-recursive-targets-and-third_002dparty-Makefiles"></a>
    88. 

  88. <p>When a user runs one of these targets, that target is run recursively
    89. 

  89. in all subdirectories.  This is why it is important that even
    90. 

  90. third-party <samp>Makefile</samp>s support them.
    91. 

  91. </p>
    92. 

  92. <dl compact="compact">
    93. 

  93. <dt><code>all</code></dt>
    94. 

  94. <dd><p>Compile the entire package.  This is the default target in
    95. 

  95. Automake-generated <samp>Makefile</samp>s, but it does not need to be the
    96. 

  96. default in third-party <samp>Makefile</samp>s.
    97. 

  97. </p>
    98. 

  98. </dd>
    99. 

  99. <dt><code>distdir</code></dt>
    100. 

  100. <dd><a name="index-distdir"></a>
    101. 

  101. <a name="index-distdir-2"></a>
    102. 

  102. <a name="index-top_005fdistdir-1"></a>
    103. 

  103. <p>Copy files to distribute into &lsquo;<samp>$(distdir)</samp>&rsquo;, before a tarball is
    104. 

  104. constructed.  Of course this target is not required if the
    105. 

  105. <samp>no-dist</samp> option (see <a href="Options.html#Options">Options</a>) is used.
    106. 

  106. </p>
    107. 

  107. <p>The variables &lsquo;<samp>$(top_distdir)</samp>&rsquo; and &lsquo;<samp>$(distdir)</samp>&rsquo;
    108. 

  108. (see <a href="The-dist-Hook.html#The-dist-Hook">The dist Hook</a>) will be passed from the outer package to the subpackage
    109. 

  109. when the <code>distdir</code> target is invoked.  These two variables have
    110. 

  110. been adjusted for the directory that is being recursed into, so they
    111. 

  111. are ready to use.
    112. 

  112. </p>
    113. 

  113. </dd>
    114. 

  114. <dt><code>install</code></dt>
    115. 

  115. <dt><code>install-data</code></dt>
    116. 

  116. <dt><code>install-exec</code></dt>
    117. 

  117. <dt><code>uninstall</code></dt>
    118. 

  118. <dd><p>Install or uninstall files (see <a href="Install.html#Install">Install</a>).
    119. 

  119. </p>
    120. 

  120. </dd>
    121. 

  121. <dt><code>install-dvi</code></dt>
    122. 

  122. <dt><code>install-html</code></dt>
    123. 

  123. <dt><code>install-info</code></dt>
    124. 

  124. <dt><code>install-ps</code></dt>
    125. 

  125. <dt><code>install-pdf</code></dt>
    126. 

  126. <dd><p>Install only some specific documentation format (see <a href="Texinfo.html#Texinfo">Texinfo</a>).
    127. 

  127. </p>
    128. 

  128. </dd>
    129. 

  129. <dt><code>installdirs</code></dt>
    130. 

  130. <dd><p>Create install directories, but do not install any files.
    131. 

  131. </p>
    132. 

  132. </dd>
    133. 

  133. <dt><code>check</code></dt>
    134. 

  134. <dt><code>installcheck</code></dt>
    135. 

  135. <dd><p>Check the package (see <a href="Tests.html#Tests">Tests</a>).
    136. 

  136. </p>
    137. 

  137. </dd>
    138. 

  138. <dt><code>mostlyclean</code></dt>
    139. 

  139. <dt><code>clean</code></dt>
    140. 

  140. <dt><code>distclean</code></dt>
    141. 

  141. <dt><code>maintainer-clean</code></dt>
    142. 

  142. <dd><p>Cleaning rules (see <a href="Clean.html#Clean">Clean</a>).
    143. 

  143. </p>
    144. 

  144. </dd>
    145. 

  145. <dt><code>dvi</code></dt>
    146. 

  146. <dt><code>pdf</code></dt>
    147. 

  147. <dt><code>ps</code></dt>
    148. 

  148. <dt><code>info</code></dt>
    149. 

  149. <dt><code>html</code></dt>
    150. 

  150. <dd><p>Build the documentation in various formats (see <a href="Texinfo.html#Texinfo">Texinfo</a>).
    151. 

  151. </p>
    152. 

  152. </dd>
    153. 

  153. <dt><code>tags</code></dt>
    154. 

  154. <dt><code>ctags</code></dt>
    155. 

  155. <dd><p>Build <samp>TAGS</samp> and <samp>CTAGS</samp> (see <a href="Tags.html#Tags">Tags</a>).
    156. 

  156. </p></dd>
    157. 

  157. </dl>
    158. 

  158. 

  159. <p>If you have ever used Gettext in a project, this is a good example of
    160. 

  160. how third-party <samp>Makefile</samp>s can be used with Automake.  The
    161. 

  161. <samp>Makefile</samp>s <code>gettextize</code> puts in the <samp>po/</samp> and
    162. 

  162. <samp>intl/</samp> directories are handwritten <samp>Makefile</samp>s that
    163. 

  163. implement all of these targets.  That way they can be added to
    164. 

  164. <code>SUBDIRS</code> in Automake packages.
    165. 

  165. </p>
    166. 

  166. <p>Directories that are only listed in <code>DIST_SUBDIRS</code> but not in
    167. 

  167. <code>SUBDIRS</code> need only the <code>distclean</code>,
    168. 

  168. <code>maintainer-clean</code>, and <code>distdir</code> rules (see <a href="Conditional-Subdirectories.html#Conditional-Subdirectories">Conditional Subdirectories</a>).
    169. 

  169. </p>
    170. 

  170. <p>Usually, many of these rules are irrelevant to the third-party
    171. 

  171. subproject, but they are required for the whole package to work.  It&rsquo;s
    172. 

  172. OK to have a rule that does nothing, so if you are integrating a
    173. 

  173. third-party project with no documentation or tag support, you could
    174. 

  174. simply augment its <samp>Makefile</samp> as follows:
    175. 

  175. </p>
    176. 

  176. <div class="example">
    177. 

  177. <pre class="example">EMPTY_AUTOMAKE_TARGETS = dvi pdf ps info html tags ctags
    178. 

  178. .PHONY: $(EMPTY_AUTOMAKE_TARGETS)
    179. 

  179. $(EMPTY_AUTOMAKE_TARGETS):
    180. 

  180. </pre></div>
    181. 

  181. 

  182. <p>Another aspect of integrating third-party build systems is whether
    183. 

  183. they support VPATH builds (see <a href="VPATH-Builds.html#VPATH-Builds">VPATH Builds</a>).  Obviously if the
    184. 

  184. subpackage does not support VPATH builds the whole package will not
    185. 

  185. support VPATH builds.  This in turns means that &lsquo;<samp>make distcheck</samp>&rsquo;
    186. 

  186. will not work, because it relies on VPATH builds.  Some people can
    187. 

  187. live without this (actually, many Automake users have never heard of
    188. 

  188. &lsquo;<samp>make distcheck</samp>&rsquo;).  Other people may prefer to revamp the
    189. 

  189. existing <samp>Makefile</samp>s to support VPATH.  Doing so does not
    190. 

  190. necessarily require Automake, only Autoconf is needed (see <a href="http://www.gnu.org/software/autoconf/manual/html_node/Build-Directories.html#Build-Directories">Build Directories</a> in <cite>The Autoconf Manual</cite>).
    191. 

  191. The necessary substitutions: &lsquo;<samp>@srcdir@</samp>&rsquo;, &lsquo;<samp>@top_srcdir@</samp>&rsquo;,
    192. 

  192. and &lsquo;<samp>@top_builddir@</samp>&rsquo; are defined by <samp>configure</samp> when it
    193. 

  193. processes a <samp>Makefile</samp> (see <a href="http://www.gnu.org/software/autoconf/manual/html_node/Preset-Output-Variables.html#Preset-Output-Variables">Preset
    194. 

  194. Output Variables</a> in <cite>The Autoconf Manual</cite>), they are not
    195. 

  195. computed by the Makefile like the aforementioned &lsquo;<samp>$(distdir)</samp>&rsquo; and
    196. 

  196. &lsquo;<samp>$(top_distdir)</samp>&rsquo; variables.
    197. 

  197. </p>
    198. 

  198. <p>It is sometimes inconvenient to modify a third-party <samp>Makefile</samp>
    199. 

  199. to introduce the above required targets.  For instance, one may want to
    200. 

  200. keep the third-party sources untouched to ease upgrades to new
    201. 

  201. versions.
    202. 

  202. </p>
    203. 

  203. <a name="index-GNUmakefile-including-Makefile"></a>
    204. 

  204. <p>Here are two other ideas.  If GNU make is assumed, one possibility is
    205. 

  205. to add to that subdirectory a <samp>GNUmakefile</samp> that defines the
    206. 

  206. required targets and includes the third-party <samp>Makefile</samp>.  For
    207. 

  207. this to work in VPATH builds, <samp>GNUmakefile</samp> must lie in the build
    208. 

  208. directory; the easiest way to do this is to write a
    209. 

  209. <samp>GNUmakefile.in</samp> instead, and have it processed with
    210. 

  210. <code>AC_CONFIG_FILES</code> from the outer package.  For example if we
    211. 

  211. assume <samp>Makefile</samp> defines all targets except the documentation
    212. 

  212. targets, and that the <code>check</code> target is actually called
    213. 

  213. <code>test</code>, we could write <samp>GNUmakefile</samp> (or
    214. 

  214. <samp>GNUmakefile.in</samp>) like this:
    215. 

  215. </p>
    216. 

  216. <div class="example">
    217. 

  217. <pre class="example"># First, include the real Makefile
    218. 

  218. include Makefile
    219. 

  219. # Then, define the other targets needed by Automake Makefiles.
    220. 

  220. .PHONY: dvi pdf ps info html check
    221. 

  221. dvi pdf ps info html:
    222. 

  222. check: test
    223. 

  223. </pre></div>
    224. 

  224. 

  225. <a name="index-Proxy-Makefile-for-third_002dparty-packages"></a>
    226. 

  226. <p>A similar idea that does not use <code>include</code> is to write a proxy
    227. 

  227. <samp>Makefile</samp> that dispatches rules to the real <samp>Makefile</samp>,
    228. 

  228. either with &lsquo;<samp>$(MAKE) -f Makefile.real $(AM_MAKEFLAGS) target</samp>&rsquo; (if
    229. 

  229. it&rsquo;s OK to rename the original <samp>Makefile</samp>) or with &lsquo;<samp>cd
    230. 

  230. subdir &amp;&amp; $(MAKE) $(AM_MAKEFLAGS) target</samp>&rsquo; (if it&rsquo;s OK to store the
    231. 

  231. subdirectory project one directory deeper).  The good news is that
    232. 

  232. this proxy <samp>Makefile</samp> can be generated with Automake.  All we
    233. 

  233. need are <samp>-local</samp> targets (see <a href="Extending.html#Extending">Extending</a>) that perform the
    234. 

  234. dispatch.  Of course the other Automake features are available, so you
    235. 

  235. could decide to let Automake perform distribution or installation.
    236. 

  236. Here is a possible <samp>Makefile.am</samp>:
    237. 

  237. </p>
    238. 

  238. <div class="example">
    239. 

  239. <pre class="example">all-local:
    240. 

  240.         cd subdir &amp;&amp; $(MAKE) $(AM_MAKEFLAGS) all
    241. 

  241. check-local:
    242. 

  242.         cd subdir &amp;&amp; $(MAKE) $(AM_MAKEFLAGS) test
    243. 

  243. clean-local:
    244. 

  244.         cd subdir &amp;&amp; $(MAKE) $(AM_MAKEFLAGS) clean
    245. 

  245. 

  246. # Assuming the package knows how to install itself
    247. 

  247. install-data-local:
    248. 

  248.         cd subdir &amp;&amp; $(MAKE) $(AM_MAKEFLAGS) install-data
    249. 

  249. install-exec-local:
    250. 

  250.         cd subdir &amp;&amp; $(MAKE) $(AM_MAKEFLAGS) install-exec
    251. 

  251. uninstall-local:
    252. 

  252.         cd subdir &amp;&amp; $(MAKE) $(AM_MAKEFLAGS) uninstall
    253. 

  253. 

  254. # Distribute files from here.
    255. 

  255. EXTRA_DIST = subdir/Makefile subdir/program.c ...
    256. 

  256. </pre></div>
    257. 

  257. 

  258. <p>Pushing this idea to the extreme, it is also possible to ignore the
    259. 

  259. subproject build system and build everything from this proxy
    260. 

  260. <samp>Makefile.am</samp>.  This might sound very sensible if you need VPATH
    261. 

  261. builds but the subproject does not support them.
    262. 

  262. </p>
    263. 

  263. <hr>
    264. 

  264. <div class="header">
    265. 

  265. <p>
    266. 

  266. Previous: <a href="Extending.html#Extending" accesskey="p" rel="prev">Extending</a>, Up: <a href="Not-Enough.html#Not-Enough" accesskey="u" rel="up">Not Enough</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Indices.html#Indices" title="Index" rel="index">Index</a>]</p>
    267. 

  267. </div>
    268. 

  268. 

  269. 

  270. 

  271. </body>
    272. 

  272. </html>
    273. 

  273.