home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-dist / make-3.75-bin.lha / info / make.info-6 (.txt) < prev    next >
GNU Info File  |  1996-10-12  |  43KB  |  749 lines

  1. This is Info file make.info, produced by Makeinfo-1.64 from the input
  2. file /ade-src/fsf/make/make.texinfo.
  3.    This file documents the GNU Make utility, which determines
  4. automatically which pieces of a large program need to be recompiled,
  5. and issues the commands to recompile them.
  6.    This is Edition 0.51, last updated 9 May 1996, of `The GNU Make
  7. Manual', for `make', Version 3.75 Beta.
  8.    Copyright (C) 1988, '89, '90, '91, '92, '93, '94, '95, '96
  9. Free Software Foundation, Inc.
  10.    Permission is granted to make and distribute verbatim copies of this
  11. manual provided the copyright notice and this permission notice are
  12. preserved on all copies.
  13.    Permission is granted to copy and distribute modified versions of
  14. this manual under the conditions for verbatim copying, provided that
  15. the entire resulting derived work is distributed under the terms of a
  16. permission notice identical to this one.
  17.    Permission is granted to copy and distribute translations of this
  18. manual into another language, under the above conditions for modified
  19. versions, except that this permission notice may be stated in a
  20. translation approved by the Free Software Foundation.
  21. File: make.info,  Node: Match-Anything Rules,  Next: Canceling Rules,  Prev: Pattern Match,  Up: Pattern Rules
  22. Match-Anything Pattern Rules
  23. ----------------------------
  24.    When a pattern rule's target is just `%', it matches any file name
  25. whatever.  We call these rules "match-anything" rules.  They are very
  26. useful, but it can take a lot of time for `make' to think about them,
  27. because it must consider every such rule for each file name listed
  28. either as a target or as a dependency.
  29.    Suppose the makefile mentions `foo.c'.  For this target, `make'
  30. would have to consider making it by linking an object file `foo.c.o',
  31. or by C compilation-and-linking in one step from `foo.c.c', or by
  32. Pascal compilation-and-linking from `foo.c.p', and many other
  33. possibilities.
  34.    We know these possibilities are ridiculous since `foo.c' is a C
  35. source file, not an executable.  If `make' did consider these
  36. possibilities, it would ultimately reject them, because files such as
  37. `foo.c.o' and `foo.c.p' would not exist.  But these possibilities are so
  38. numerous that `make' would run very slowly if it had to consider them.
  39.    To gain speed, we have put various constraints on the way `make'
  40. considers match-anything rules.  There are two different constraints
  41. that can be applied, and each time you define a match-anything rule you
  42. must choose one or the other for that rule.
  43.    One choice is to mark the match-anything rule as "terminal" by
  44. defining it with a double colon.  When a rule is terminal, it does not
  45. apply unless its dependencies actually exist.  Dependencies that could
  46. be made with other implicit rules are not good enough.  In other words,
  47. no further chaining is allowed beyond a terminal rule.
  48.    For example, the built-in implicit rules for extracting sources from
  49. RCS and SCCS files are terminal; as a result, if the file `foo.c,v' does
  50. not exist, `make' will not even consider trying to make it as an
  51. intermediate file from `foo.c,v.o' or from `RCS/SCCS/s.foo.c,v'.  RCS
  52. and SCCS files are generally ultimate source files, which should not be
  53. remade from any other files; therefore, `make' can save time by not
  54. looking for ways to remake them.
  55.    If you do not mark the match-anything rule as terminal, then it is
  56. nonterminal.  A nonterminal match-anything rule cannot apply to a file
  57. name that indicates a specific type of data.  A file name indicates a
  58. specific type of data if some non-match-anything implicit rule target
  59. matches it.
  60.    For example, the file name `foo.c' matches the target for the pattern
  61. rule `%.c : %.y' (the rule to run Yacc).  Regardless of whether this
  62. rule is actually applicable (which happens only if there is a file
  63. `foo.y'), the fact that its target matches is enough to prevent
  64. consideration of any nonterminal match-anything rules for the file
  65. `foo.c'.  Thus, `make' will not even consider trying to make `foo.c' as
  66. an executable file from `foo.c.o', `foo.c.c', `foo.c.p', etc.
  67.    The motivation for this constraint is that nonterminal match-anything
  68. rules are used for making files containing specific types of data (such
  69. as executable files) and a file name with a recognized suffix indicates
  70. some other specific type of data (such as a C source file).
  71.    Special built-in dummy pattern rules are provided solely to recognize
  72. certain file names so that nonterminal match-anything rules will not be
  73. considered.  These dummy rules have no dependencies and no commands, and
  74. they are ignored for all other purposes.  For example, the built-in
  75. implicit rule
  76.      %.p :
  77. exists to make sure that Pascal source files such as `foo.p' match a
  78. specific target pattern and thereby prevent time from being wasted
  79. looking for `foo.p.o' or `foo.p.c'.
  80.    Dummy pattern rules such as the one for `%.p' are made for every
  81. suffix listed as valid for use in suffix rules (*note Old-Fashioned
  82. Suffix Rules: Suffix Rules.).
  83. File: make.info,  Node: Canceling Rules,  Prev: Match-Anything Rules,  Up: Pattern Rules
  84. Canceling Implicit Rules
  85. ------------------------
  86.    You can override a built-in implicit rule (or one you have defined
  87. yourself) by defining a new pattern rule with the same target and
  88. dependencies, but different commands.  When the new rule is defined, the
  89. built-in one is replaced.  The new rule's position in the sequence of
  90. implicit rules is determined by where you write the new rule.
  91.    You can cancel a built-in implicit rule by defining a pattern rule
  92. with the same target and dependencies, but no commands.  For example,
  93. the following would cancel the rule that runs the assembler:
  94.      %.o : %.s
  95. File: make.info,  Node: Last Resort,  Next: Suffix Rules,  Prev: Pattern Rules,  Up: Implicit Rules
  96. Defining Last-Resort Default Rules
  97. ==================================
  98.    You can define a last-resort implicit rule by writing a terminal
  99. match-anything pattern rule with no dependencies (*note Match-Anything
  100. Rules::.).  This is just like any other pattern rule; the only thing
  101. special about it is that it will match any target.  So such a rule's
  102. commands are used for all targets and dependencies that have no commands
  103. of their own and for which no other implicit rule applies.
  104.    For example, when testing a makefile, you might not care if the
  105. source files contain real data, only that they exist.  Then you might
  106. do this:
  107.      %::
  108.              touch $@
  109. to cause all the source files needed (as dependencies) to be created
  110. automatically.
  111.    You can instead define commands to be used for targets for which
  112. there are no rules at all, even ones which don't specify commands.  You
  113. do this by writing a rule for the target `.DEFAULT'.  Such a rule's
  114. commands are used for all dependencies which do not appear as targets in
  115. any explicit rule, and for which no implicit rule applies.  Naturally,
  116. there is no `.DEFAULT' rule unless you write one.
  117.    If you use `.DEFAULT' with no commands or dependencies:
  118.      .DEFAULT:
  119. the commands previously stored for `.DEFAULT' are cleared.  Then `make'
  120. acts as if you had never defined `.DEFAULT' at all.
  121.    If you do not want a target to get the commands from a match-anything
  122. pattern rule or `.DEFAULT', but you also do not want any commands to be
  123. run for the target, you can give it empty commands (*note Defining
  124. Empty Commands: Empty Commands.).
  125.    You can use a last-resort rule to override part of another makefile.
  126. *Note Overriding Part of Another Makefile: Overriding Makefiles.
  127. File: make.info,  Node: Suffix Rules,  Next: Search Algorithm,  Prev: Last Resort,  Up: Implicit Rules
  128. Old-Fashioned Suffix Rules
  129. ==========================
  130.    "Suffix rules" are the old-fashioned way of defining implicit rules
  131. for `make'.  Suffix rules are obsolete because pattern rules are more
  132. general and clearer.  They are supported in GNU `make' for
  133. compatibility with old makefiles.  They come in two kinds:
  134. "double-suffix" and "single-suffix".
  135.    A double-suffix rule is defined by a pair of suffixes: the target
  136. suffix and the source suffix.  It matches any file whose name ends with
  137. the target suffix.  The corresponding implicit dependency is made by
  138. replacing the target suffix with the source suffix in the file name.  A
  139. two-suffix rule whose target and source suffixes are `.o' and `.c' is
  140. equivalent to the pattern rule `%.o : %.c'.
  141.    A single-suffix rule is defined by a single suffix, which is the
  142. source suffix.  It matches any file name, and the corresponding implicit
  143. dependency name is made by appending the source suffix.  A single-suffix
  144. rule whose source suffix is `.c' is equivalent to the pattern rule `% :
  145. %.c'.
  146.    Suffix rule definitions are recognized by comparing each rule's
  147. target against a defined list of known suffixes.  When `make' sees a
  148. rule whose target is a known suffix, this rule is considered a
  149. single-suffix rule.  When `make' sees a rule whose target is two known
  150. suffixes concatenated, this rule is taken as a double-suffix rule.
  151.    For example, `.c' and `.o' are both on the default list of known
  152. suffixes.  Therefore, if you define a rule whose target is `.c.o',
  153. `make' takes it to be a double-suffix rule with source suffix `.c' and
  154. target suffix `.o'.  Here is the old-fashioned way to define the rule
  155. for compiling a C source file:
  156.      .c.o:
  157.              $(CC) -c $(CFLAGS) $(CPPFLAGS) -o $@ $<
  158.    Suffix rules cannot have any dependencies of their own.  If they
  159. have any, they are treated as normal files with funny names, not as
  160. suffix rules.  Thus, the rule:
  161.      .c.o: foo.h
  162.              $(CC) -c $(CFLAGS) $(CPPFLAGS) -o $@ $<
  163. tells how to make the file `.c.o' from the dependency file `foo.h', and
  164. is not at all like the pattern rule:
  165.      %.o: %.c foo.h
  166.              $(CC) -c $(CFLAGS) $(CPPFLAGS) -o $@ $<
  167. which tells how to make `.o' files from `.c' files, and makes all `.o'
  168. files using this pattern rule also depend on `foo.h'.
  169.    Suffix rules with no commands are also meaningless.  They do not
  170. remove previous rules as do pattern rules with no commands (*note
  171. Canceling Implicit Rules: Canceling Rules.).  They simply enter the
  172. suffix or pair of suffixes concatenated as a target in the data base.
  173.    The known suffixes are simply the names of the dependencies of the
  174. special target `.SUFFIXES'.  You can add your own suffixes by writing a
  175. rule for `.SUFFIXES' that adds more dependencies, as in:
  176.      .SUFFIXES: .hack .win
  177. which adds `.hack' and `.win' to the end of the list of suffixes.
  178.    If you wish to eliminate the default known suffixes instead of just
  179. adding to them, write a rule for `.SUFFIXES' with no dependencies.  By
  180. special dispensation, this eliminates all existing dependencies of
  181. `.SUFFIXES'.  You can then write another rule to add the suffixes you
  182. want.  For example,
  183.      .SUFFIXES:            # Delete the default suffixes
  184.      .SUFFIXES: .c .o .h   # Define our suffix list
  185.    The `-r' or `--no-builtin-rules' flag causes the default list of
  186. suffixes to be empty.
  187.    The variable `SUFFIXES' is defined to the default list of suffixes
  188. before `make' reads any makefiles.  You can change the list of suffixes
  189. with a rule for the special target `.SUFFIXES', but that does not alter
  190. this variable.
  191. File: make.info,  Node: Search Algorithm,  Prev: Suffix Rules,  Up: Implicit Rules
  192. Implicit Rule Search Algorithm
  193. ==============================
  194.    Here is the procedure `make' uses for searching for an implicit rule
  195. for a target T.  This procedure is followed for each double-colon rule
  196. with no commands, for each target of ordinary rules none of which have
  197. commands, and for each dependency that is not the target of any rule.
  198. It is also followed recursively for dependencies that come from implicit
  199. rules, in the search for a chain of rules.
  200.    Suffix rules are not mentioned in this algorithm because suffix
  201. rules are converted to equivalent pattern rules once the makefiles have
  202. been read in.
  203.    For an archive member target of the form `ARCHIVE(MEMBER)', the
  204. following algorithm is run twice, first using the entire target name T,
  205. and second using `(MEMBER)' as the target T if the first run found no
  206. rule.
  207.   1. Split T into a directory part, called D, and the rest, called N.
  208.      For example, if T is `src/foo.o', then D is `src/' and N is
  209.      `foo.o'.
  210.   2. Make a list of all the pattern rules one of whose targets matches
  211.      T or N.  If the target pattern contains a slash, it is matched
  212.      against T; otherwise, against N.
  213.   3. If any rule in that list is *not* a match-anything rule, then
  214.      remove all nonterminal match-anything rules from the list.
  215.   4. Remove from the list all rules with no commands.
  216.   5. For each pattern rule in the list:
  217.        a. Find the stem S, which is the nonempty part of T or N matched
  218.           by the `%' in the target pattern.
  219.        b. Compute the dependency names by substituting S for `%'; if
  220.           the target pattern does not contain a slash, append D to the
  221.           front of each dependency name.
  222.        c. Test whether all the dependencies exist or ought to exist.
  223.           (If a file name is mentioned in the makefile as a target or
  224.           as an explicit dependency, then we say it ought to exist.)
  225.           If all dependencies exist or ought to exist, or there are no
  226.           dependencies, then this rule applies.
  227.   6. If no pattern rule has been found so far, try harder.  For each
  228.      pattern rule in the list:
  229.        a. If the rule is terminal, ignore it and go on to the next rule.
  230.        b. Compute the dependency names as before.
  231.        c. Test whether all the dependencies exist or ought to exist.
  232.        d. For each dependency that does not exist, follow this algorithm
  233.           recursively to see if the dependency can be made by an
  234.           implicit rule.
  235.        e. If all dependencies exist, ought to exist, or can be made by
  236.           implicit rules, then this rule applies.
  237.   7. If no implicit rule applies, the rule for `.DEFAULT', if any,
  238.      applies.  In that case, give T the same commands that `.DEFAULT'
  239.      has.  Otherwise, there are no commands for T.
  240.    Once a rule that applies has been found, for each target pattern of
  241. the rule other than the one that matched T or N, the `%' in the pattern
  242. is replaced with S and the resultant file name is stored until the
  243. commands to remake the target file T are executed.  After these
  244. commands are executed, each of these stored file names are entered into
  245. the data base and marked as having been updated and having the same
  246. update status as the file T.
  247.    When the commands of a pattern rule are executed for T, the automatic
  248. variables are set corresponding to the target and dependencies.  *Note
  249. Automatic Variables: Automatic.
  250. File: make.info,  Node: Archives,  Next: Features,  Prev: Implicit Rules,  Up: Top
  251. Using `make' to Update Archive Files
  252. ************************************
  253.    "Archive files" are files containing named subfiles called
  254. "members"; they are maintained with the program `ar' and their main use
  255. is as subroutine libraries for linking.
  256. * Menu:
  257. * Archive Members::             Archive members as targets.
  258. * Archive Update::              The implicit rule for archive member targets.
  259. * Archive Pitfalls::            Dangers to watch out for when using archives.
  260. * Archive Suffix Rules::        You can write a special kind of suffix rule
  261.                                   for updating archives.
  262. File: make.info,  Node: Archive Members,  Next: Archive Update,  Up: Archives
  263. Archive Members as Targets
  264. ==========================
  265.    An individual member of an archive file can be used as a target or
  266. dependency in `make'.  You specify the member named MEMBER in archive
  267. file ARCHIVE as follows:
  268.      ARCHIVE(MEMBER)
  269. This construct is available only in targets and dependencies, not in
  270. commands!  Most programs that you might use in commands do not support
  271. this syntax and cannot act directly on archive members.  Only `ar' and
  272. other programs specifically designed to operate on archives can do so.
  273. Therefore, valid commands to update an archive member target probably
  274. must use `ar'.  For example, this rule says to create a member `hack.o'
  275. in archive `foolib' by copying the file `hack.o':
  276.      foolib(hack.o) : hack.o
  277.              ar cr foolib hack.o
  278.    In fact, nearly all archive member targets are updated in just this
  279. way and there is an implicit rule to do it for you.  *Note:* The `c'
  280. flag to `ar' is required if the archive file does not already exist.
  281.    To specify several members in the same archive, you can write all the
  282. member names together between the parentheses.  For example:
  283.      foolib(hack.o kludge.o)
  284. is equivalent to:
  285.      foolib(hack.o) foolib(kludge.o)
  286.    You can also use shell-style wildcards in an archive member
  287. reference.  *Note Using Wildcard Characters in File Names: Wildcards.
  288. For example, `foolib(*.o)' expands to all existing members of the
  289. `foolib' archive whose names end in `.o'; perhaps `foolib(hack.o)
  290. foolib(kludge.o)'.
  291. File: make.info,  Node: Archive Update,  Next: Archive Pitfalls,  Prev: Archive Members,  Up: Archives
  292. Implicit Rule for Archive Member Targets
  293. ========================================
  294.    Recall that a target that looks like `A(M)' stands for the member
  295. named M in the archive file A.
  296.    When `make' looks for an implicit rule for such a target, as a
  297. special feature it considers implicit rules that match `(M)', as well as
  298. those that match the actual target `A(M)'.
  299.    This causes one special rule whose target is `(%)' to match.  This
  300. rule updates the target `A(M)' by copying the file M into the archive.
  301. For example, it will update the archive member target `foo.a(bar.o)' by
  302. copying the *file* `bar.o' into the archive `foo.a' as a *member* named
  303. `bar.o'.
  304.    When this rule is chained with others, the result is very powerful.
  305. Thus, `make "foo.a(bar.o)"' (the quotes are needed to protect the `('
  306. and `)' from being interpreted specially by the shell) in the presence
  307. of a file `bar.c' is enough to cause the following commands to be run,
  308. even without a makefile:
  309.      cc -c bar.c -o bar.o
  310.      ar r foo.a bar.o
  311.      rm -f bar.o
  312. Here `make' has envisioned the file `bar.o' as an intermediate file.
  313. *Note Chains of Implicit Rules: Chained Rules.
  314.    Implicit rules such as this one are written using the automatic
  315. variable `$%'.  *Note Automatic Variables: Automatic.
  316.    An archive member name in an archive cannot contain a directory
  317. name, but it may be useful in a makefile to pretend that it does.  If
  318. you write an archive member target `foo.a(dir/file.o)', `make' will
  319. perform automatic updating with this command:
  320.      ar r foo.a dir/file.o
  321. which has the effect of copying the file `dir/file.o' into a member
  322. named `file.o'.  In connection with such usage, the automatic variables
  323. `%D' and `%F' may be useful.
  324. * Menu:
  325. * Archive Symbols::             How to update archive symbol directories.
  326. File: make.info,  Node: Archive Symbols,  Up: Archive Update
  327. Updating Archive Symbol Directories
  328. -----------------------------------
  329.    An archive file that is used as a library usually contains a special
  330. member named `__.SYMDEF' that contains a directory of the external
  331. symbol names defined by all the other members.  After you update any
  332. other members, you need to update `__.SYMDEF' so that it will summarize
  333. the other members properly.  This is done by running the `ranlib'
  334. program:
  335.      ranlib ARCHIVEFILE
  336.    Normally you would put this command in the rule for the archive file,
  337. and make all the members of the archive file dependencies of that rule.
  338. For example,
  339.      libfoo.a: libfoo.a(x.o) libfoo.a(y.o) ...
  340.              ranlib libfoo.a
  341. The effect of this is to update archive members `x.o', `y.o', etc., and
  342. then update the symbol directory member `__.SYMDEF' by running
  343. `ranlib'.  The rules for updating the members are not shown here; most
  344. likely you can omit them and use the implicit rule which copies files
  345. into the archive, as described in the preceding section.
  346.    This is not necessary when using the GNU `ar' program, which updates
  347. the `__.SYMDEF' member automatically.
  348. File: make.info,  Node: Archive Pitfalls,  Next: Archive Suffix Rules,  Prev: Archive Update,  Up: Archives
  349. Dangers When Using Archives
  350. ===========================
  351.    It is important to be careful when using parallel execution (the
  352. `-j' switch; *note Parallel Execution: Parallel.) and archives.  If
  353. multiple `ar' commands run at the same time on the same archive file,
  354. they will not know about each other and can corrupt the file.
  355.    Possibly a future version of `make' will provide a mechanism to
  356. circumvent this problem by serializing all commands that operate on the
  357. same archive file.  But for the time being, you must either write your
  358. makefiles to avoid this problem in some other way, or not use `-j'.
  359. File: make.info,  Node: Archive Suffix Rules,  Prev: Archive Pitfalls,  Up: Archives
  360. Suffix Rules for Archive Files
  361. ==============================
  362.    You can write a special kind of suffix rule for dealing with archive
  363. files.  *Note Suffix Rules::, for a full explanation of suffix rules.
  364. Archive suffix rules are obsolete in GNU `make', because pattern rules
  365. for archives are a more general mechanism (*note Archive Update::.).
  366. But they are retained for compatibility with other `make's.
  367.    To write a suffix rule for archives, you simply write a suffix rule
  368. using the target suffix `.a' (the usual suffix for archive files).  For
  369. example, here is the old-fashioned suffix rule to update a library
  370. archive from C source files:
  371.      .c.a:
  372.              $(CC) $(CFLAGS) $(CPPFLAGS) -c $< -o $*.o
  373.              $(AR) r $@ $*.o
  374.              $(RM) $*.o
  375. This works just as if you had written the pattern rule:
  376.      (%.o): %.c
  377.              $(CC) $(CFLAGS) $(CPPFLAGS) -c $< -o $*.o
  378.              $(AR) r $@ $*.o
  379.              $(RM) $*.o
  380.    In fact, this is just what `make' does when it sees a suffix rule
  381. with `.a' as the target suffix.  Any double-suffix rule `.X.a' is
  382. converted to a pattern rule with the target pattern `(%.o)' and a
  383. dependency pattern of `%.X'.
  384.    Since you might want to use `.a' as the suffix for some other kind
  385. of file, `make' also converts archive suffix rules to pattern rules in
  386. the normal way (*note Suffix Rules::.).  Thus a double-suffix rule
  387. `.X.a' produces two pattern rules: `(%.o): %.X' and `%.a: %.X'.
  388. File: make.info,  Node: Features,  Next: Missing,  Prev: Archives,  Up: Top
  389. Features of GNU `make'
  390. **********************
  391.    Here is a summary of the features of GNU `make', for comparison with
  392. and credit to other versions of `make'.  We consider the features of
  393. `make' in 4.2 BSD systems as a baseline.  If you are concerned with
  394. writing portable makefiles, you should use only the features of `make'
  395. *not* listed here or in *Note Missing::.
  396.    Many features come from the version of `make' in System V.
  397.    * The `VPATH' variable and its special meaning.  *Note Searching
  398.      Directories for Dependencies: Directory Search.  This feature
  399.      exists in System V `make', but is undocumented.  It is documented
  400.      in 4.3 BSD `make' (which says it mimics System V's `VPATH'
  401.      feature).
  402.    * Included makefiles.  *Note Including Other Makefiles: Include.
  403.      Allowing multiple files to be included with a single directive is
  404.      a GNU extension.
  405.    * Variables are read from and communicated via the environment.
  406.      *Note Variables from the Environment: Environment.
  407.    * Options passed through the variable `MAKEFLAGS' to recursive
  408.      invocations of `make'.  *Note Communicating Options to a
  409.      Sub-`make': Options/Recursion.
  410.    * The automatic variable `$%' is set to the member name in an
  411.      archive reference.  *Note Automatic Variables: Automatic.
  412.    * The automatic variables `$@', `$*', `$<', `$%', and `$?' have
  413.      corresponding forms like `$(@F)' and `$(@D)'.  We have generalized
  414.      this to `$^' as an obvious extension.  *Note Automatic Variables:
  415.      Automatic.
  416.    * Substitution variable references.  *Note Basics of Variable
  417.      References: Reference.
  418.    * The command-line options `-b' and `-m', accepted and ignored.  In
  419.      System V `make', these options actually do something.
  420.    * Execution of recursive commands to run `make' via the variable
  421.      `MAKE' even if `-n', `-q' or `-t' is specified.  *Note Recursive
  422.      Use of `make': Recursion.
  423.    * Support for suffix `.a' in suffix rules.  *Note Archive Suffix
  424.      Rules::.  This feature is obsolete in GNU `make', because the
  425.      general feature of rule chaining (*note Chains of Implicit Rules:
  426.      Chained Rules.) allows one pattern rule for installing members in
  427.      an archive (*note Archive Update::.) to be sufficient.
  428.    * The arrangement of lines and backslash-newline combinations in
  429.      commands is retained when the commands are printed, so they appear
  430.      as they do in the makefile, except for the stripping of initial
  431.      whitespace.
  432.    The following features were inspired by various other versions of
  433. `make'.  In some cases it is unclear exactly which versions inspired
  434. which others.
  435.    * Pattern rules using `%'.  This has been implemented in several
  436.      versions of `make'.  We're not sure who invented it first, but
  437.      it's been spread around a bit.  *Note Defining and Redefining
  438.      Pattern Rules: Pattern Rules.
  439.    * Rule chaining and implicit intermediate files.  This was
  440.      implemented by Stu Feldman in his version of `make' for AT&T
  441.      Eighth Edition Research Unix, and later by Andrew Hume of AT&T
  442.      Bell Labs in his `mk' program (where he terms it "transitive
  443.      closure").  We do not really know if we got this from either of
  444.      them or thought it up ourselves at the same time.  *Note Chains of
  445.      Implicit Rules: Chained Rules.
  446.    * The automatic variable `$^' containing a list of all dependencies
  447.      of the current target.  We did not invent this, but we have no
  448.      idea who did.  *Note Automatic Variables: Automatic.  The
  449.      automatic variable `$+' is a simple extension of `$^'.
  450.    * The "what if" flag (`-W' in GNU `make') was (as far as we know)
  451.      invented by Andrew Hume in `mk'.  *Note Instead of Executing the
  452.      Commands: Instead of Execution.
  453.    * The concept of doing several things at once (parallelism) exists in
  454.      many incarnations of `make' and similar programs, though not in the
  455.      System V or BSD implementations.  *Note Command Execution:
  456.      Execution.
  457.    * Modified variable references using pattern substitution come from
  458.      SunOS 4.  *Note Basics of Variable References: Reference.  This
  459.      functionality was provided in GNU `make' by the `patsubst'
  460.      function before the alternate syntax was implemented for
  461.      compatibility with SunOS 4.  It is not altogether clear who
  462.      inspired whom, since GNU `make' had `patsubst' before SunOS 4 was
  463.      released.
  464.    * The special significance of `+' characters preceding command lines
  465.      (*note Instead of Executing the Commands: Instead of Execution.) is
  466.      mandated by `IEEE Standard 1003.2-1992' (POSIX.2).
  467.    * The `+=' syntax to append to the value of a variable comes from
  468.      SunOS 4 `make'.  *Note Appending More Text to Variables: Appending.
  469.    * The syntax `ARCHIVE(MEM1 MEM2...)' to list multiple members in a
  470.      single archive file comes from SunOS 4 `make'.  *Note Archive
  471.      Members::.
  472.    * The `-include' directive to include makefiles with no error for a
  473.      nonexistent file comes from SunOS 4 `make'.  (But note that SunOS 4
  474.      `make' does not allow multiple makefiles to be specified in one
  475.      `-include' directive.)  The same feature appears with the name
  476.      `sinclude' in SGI `make' and perhaps others.
  477.    The remaining features are inventions new in GNU `make':
  478.    * Use the `-v' or `--version' option to print version and copyright
  479.      information.
  480.    * Use the `-h' or `--help' option to summarize the options to `make'.
  481.    * Simply-expanded variables.  *Note The Two Flavors of Variables:
  482.      Flavors.
  483.    * Pass command-line variable assignments automatically through the
  484.      variable `MAKE' to recursive `make' invocations.  *Note Recursive
  485.      Use of `make': Recursion.
  486.    * Use the `-C' or `--directory' command option to change directory.
  487.      *Note Summary of Options: Options Summary.
  488.    * Make verbatim variable definitions with `define'.  *Note Defining
  489.      Variables Verbatim: Defining.
  490.    * Declare phony targets with the special target `.PHONY'.
  491.      Andrew Hume of AT&T Bell Labs implemented a similar feature with a
  492.      different syntax in his `mk' program.  This seems to be a case of
  493.      parallel discovery.  *Note Phony Targets: Phony Targets.
  494.    * Manipulate text by calling functions.  *Note Functions for
  495.      Transforming Text: Functions.
  496.    * Use the `-o' or `--old-file' option to pretend a file's
  497.      modification-time is old.  *Note Avoiding Recompilation of Some
  498.      Files: Avoiding Compilation.
  499.    * Conditional execution.
  500.      This feature has been implemented numerous times in various
  501.      versions of `make'; it seems a natural extension derived from the
  502.      features of the C preprocessor and similar macro languages and is
  503.      not a revolutionary concept.  *Note Conditional Parts of
  504.      Makefiles: Conditionals.
  505.    * Specify a search path for included makefiles.  *Note Including
  506.      Other Makefiles: Include.
  507.    * Specify extra makefiles to read with an environment variable.
  508.      *Note The Variable `MAKEFILES': MAKEFILES Variable.
  509.    * Strip leading sequences of `./' from file names, so that `./FILE'
  510.      and `FILE' are considered to be the same file.
  511.    * Use a special search method for library dependencies written in the
  512.      form `-lNAME'.  *Note Directory Search for Link Libraries:
  513.      Libraries/Search.
  514.    * Allow suffixes for suffix rules (*note Old-Fashioned Suffix Rules:
  515.      Suffix Rules.) to contain any characters.  In other versions of
  516.      `make', they must begin with `.' and not contain any `/'
  517.      characters.
  518.    * Keep track of the current level of `make' recursion using the
  519.      variable `MAKELEVEL'.  *Note Recursive Use of `make': Recursion.
  520.    * Specify static pattern rules.  *Note Static Pattern Rules: Static
  521.      Pattern.
  522.    * Provide selective `vpath' search.  *Note Searching Directories for
  523.      Dependencies: Directory Search.
  524.    * Provide computed variable references.  *Note Basics of Variable
  525.      References: Reference.
  526.    * Update makefiles.  *Note How Makefiles Are Remade: Remaking
  527.      Makefiles.  System V `make' has a very, very limited form of this
  528.      functionality in that it will check out SCCS files for makefiles.
  529.    * Various new built-in implicit rules.  *Note Catalogue of Implicit
  530.      Rules: Catalogue of Rules.
  531.    * The built-in variable `MAKE_VERSION' gives the version number of
  532.      `make'.
  533. File: make.info,  Node: Missing,  Next: Makefile Conventions,  Prev: Features,  Up: Top
  534. Incompatibilities and Missing Features
  535. **************************************
  536.    The `make' programs in various other systems support a few features
  537. that are not implemented in GNU `make'.  The POSIX.2 standard (`IEEE
  538. Standard 1003.2-1992') which specifies `make' does not require any of
  539. these features.
  540.    * A target of the form `FILE((ENTRY))' stands for a member of
  541.      archive file FILE.  The member is chosen, not by name, but by
  542.      being an object file which defines the linker symbol ENTRY.
  543.      This feature was not put into GNU `make' because of the
  544.      nonmodularity of putting knowledge into `make' of the internal
  545.      format of archive file symbol tables.  *Note Updating Archive
  546.      Symbol Directories: Archive Symbols.
  547.    * Suffixes (used in suffix rules) that end with the character `~'
  548.      have a special meaning to System V `make'; they refer to the SCCS
  549.      file that corresponds to the file one would get without the `~'.
  550.      For example, the suffix rule `.c~.o' would make the file `N.o' from
  551.      the SCCS file `s.N.c'.  For complete coverage, a whole series of
  552.      such suffix rules is required.  *Note Old-Fashioned Suffix Rules:
  553.      Suffix Rules.
  554.      In GNU `make', this entire series of cases is handled by two
  555.      pattern rules for extraction from SCCS, in combination with the
  556.      general feature of rule chaining.  *Note Chains of Implicit Rules:
  557.      Chained Rules.
  558.    * In System V `make', the string `$$@' has the strange meaning that,
  559.      in the dependencies of a rule with multiple targets, it stands for
  560.      the particular target that is being processed.
  561.      This is not defined in GNU `make' because `$$' should always stand
  562.      for an ordinary `$'.
  563.      It is possible to get this functionality through the use of static
  564.      pattern rules (*note Static Pattern Rules: Static Pattern.).  The
  565.      System V `make' rule:
  566.           $(targets): $$@.o lib.a
  567.      can be replaced with the GNU `make' static pattern rule:
  568.           $(targets): %: %.o lib.a
  569.    * In System V and 4.3 BSD `make', files found by `VPATH' search
  570.      (*note Searching Directories for Dependencies: Directory Search.)
  571.      have their names changed inside command strings.  We feel it is
  572.      much cleaner to always use automatic variables and thus make this
  573.      feature obsolete.
  574.    * In some Unix `make's, the automatic variable `$*' appearing in the
  575.      dependencies of a rule has the amazingly strange "feature" of
  576.      expanding to the full name of the *target of that rule*.  We cannot
  577.      imagine what went on in the minds of Unix `make' developers to do
  578.      this; it is utterly inconsistent with the normal definition of
  579.      `$*'.
  580.    * In some Unix `make's, implicit rule search (*note Using Implicit
  581.      Rules: Implicit Rules.) is apparently done for *all* targets, not
  582.      just those without commands.  This means you can do:
  583.           foo.o:
  584.                   cc -c foo.c
  585.      and Unix `make' will intuit that `foo.o' depends on `foo.c'.
  586.      We feel that such usage is broken.  The dependency properties of
  587.      `make' are well-defined (for GNU `make', at least), and doing such
  588.      a thing simply does not fit the model.
  589.    * GNU `make' does not include any built-in implicit rules for
  590.      compiling or preprocessing EFL programs.  If we hear of anyone who
  591.      is using EFL, we will gladly add them.
  592.    * It appears that in SVR4 `make', a suffix rule can be specified with
  593.      no commands, and it is treated as if it had empty commands (*note
  594.      Empty Commands::.).  For example:
  595.           .c.a:
  596.      will override the built-in `.c.a' suffix rule.
  597.      We feel that it is cleaner for a rule without commands to always
  598.      simply add to the dependency list for the target.  The above
  599.      example can be easily rewritten to get the desired behavior in GNU
  600.      `make':
  601.           .c.a: ;
  602.    * Some versions of `make' invoke the shell with the `-e' flag,
  603.      except under `-k' (*note Testing the Compilation of a Program:
  604.      Testing.).  The `-e' flag tells the shell to exit as soon as any
  605.      program it runs returns a nonzero status.  We feel it is cleaner to
  606.      write each shell command line to stand on its own and not require
  607.      this special treatment.
  608. File: make.info,  Node: Makefile Conventions,  Next: Quick Reference,  Prev: Missing,  Up: Top
  609. Makefile Conventions
  610. ********************
  611.    This node describes conventions for writing the Makefiles for GNU
  612. programs.
  613. * Menu:
  614. * Makefile Basics::        General Conventions for Makefiles
  615. * Utilities in Makefiles::    Utilities in Makefiles
  616. * Command Variables::        Variables for Specifying Commands
  617. * Directory Variables::        Variables for Installation Directories
  618. * Standard Targets::        Standard Targets for Users
  619. File: make.info,  Node: Makefile Basics,  Next: Utilities in Makefiles,  Up: Makefile Conventions
  620. General Conventions for Makefiles
  621. =================================
  622.    Every Makefile should contain this line:
  623.      SHELL = /bin/sh
  624. to avoid trouble on systems where the `SHELL' variable might be
  625. inherited from the environment.  (This is never a problem with GNU
  626. `make'.)
  627.    Different `make' programs have incompatible suffix lists and
  628. implicit rules, and this sometimes creates confusion or misbehavior.  So
  629. it is a good idea to set the suffix list explicitly using only the
  630. suffixes you need in the particular Makefile, like this:
  631.      .SUFFIXES:
  632.      .SUFFIXES: .c .o
  633. The first line clears out the suffix list, the second introduces all
  634. suffixes which may be subject to implicit rules in this Makefile.
  635.    Don't assume that `.' is in the path for command execution.  When
  636. you need to run programs that are a part of your package during the
  637. make, please make sure that it uses `./' if the program is built as
  638. part of the make or `$(srcdir)/' if the file is an unchanging part of
  639. the source code.  Without one of these prefixes, the current search
  640. path is used.
  641.    The distinction between `./' and `$(srcdir)/' is important when
  642. using the `--srcdir' option to `configure'.  A rule of the form:
  643.      foo.1 : foo.man sedscript
  644.              sed -e sedscript foo.man > foo.1
  645. will fail when the current directory is not the source directory,
  646. because `foo.man' and `sedscript' are not in the current directory.
  647.    When using GNU `make', relying on `VPATH' to find the source file
  648. will work in the case where there is a single dependency file, since
  649. the `make' automatic variable `$<' will represent the source file
  650. wherever it is.  (Many versions of `make' set `$<' only in implicit
  651. rules.)  A Makefile target like
  652.      foo.o : bar.c
  653.              $(CC) -I. -I$(srcdir) $(CFLAGS) -c bar.c -o foo.o
  654. should instead be written as
  655.      foo.o : bar.c
  656.              $(CC) -I. -I$(srcdir) $(CFLAGS) -c $< -o $@
  657. in order to allow `VPATH' to work correctly.  When the target has
  658. multiple dependencies, using an explicit `$(srcdir)' is the easiest way
  659. to make the rule work well.  For example, the target above for `foo.1'
  660. is best written as:
  661.      foo.1 : foo.man sedscript
  662.              sed -e $(srcdir)/sedscript $(srcdir)/foo.man > $@
  663.    Try to make the build and installation targets, at least (and all
  664. their subtargets) work correctly with a parallel `make'.
  665. File: make.info,  Node: Utilities in Makefiles,  Next: Command Variables,  Prev: Makefile Basics,  Up: Makefile Conventions
  666. Utilities in Makefiles
  667. ======================
  668.    Write the Makefile commands (and any shell scripts, such as
  669. `configure') to run in `sh', not in `csh'.  Don't use any special
  670. features of `ksh' or `bash'.
  671.    The `configure' script and the Makefile rules for building and
  672. installation should not use any utilities directly except these:
  673.      cat cmp cp echo egrep expr false grep
  674.      ln mkdir mv pwd rm rmdir sed test touch true
  675.    Stick to the generally supported options for these programs.  For
  676. example, don't use `mkdir -p', convenient as it may be, because most
  677. systems don't support it.
  678.    It is a good idea to avoid creating symbolic links in makefiles,
  679. since a few systems don't support them.
  680.    The Makefile rules for building and installation can also use
  681. compilers and related programs, but should do so via `make' variables
  682. so that the user can substitute alternatives.  Here are some of the
  683. programs we mean:
  684.      ar bison cc flex install ld lex
  685.      make makeinfo ranlib texi2dvi yacc
  686.    Use the following `make' variables:
  687.      $(AR) $(BISON) $(CC) $(FLEX) $(INSTALL) $(LD) $(LEX)
  688.      $(MAKE) $(MAKEINFO) $(RANLIB) $(TEXI2DVI) $(YACC)
  689.    When you use `ranlib', you should make sure nothing bad happens if
  690. the system does not have `ranlib'.  Arrange to ignore an error from
  691. that command, and print a message before the command to tell the user
  692. that failure of the `ranlib' command does not mean a problem.  (The
  693. Autoconf `AC_PROG_RANLIB' macro can help with this.)
  694.    If you use symbolic links, you should implement a fallback for
  695. systems that don't have symbolic links.
  696.    It is ok to use other utilities in Makefile portions (or scripts)
  697. intended only for particular systems where you know those utilities
  698. exist.
  699. File: make.info,  Node: Command Variables,  Next: Directory Variables,  Prev: Utilities in Makefiles,  Up: Makefile Conventions
  700. Variables for Specifying Commands
  701. =================================
  702.    Makefiles should provide variables for overriding certain commands,
  703. options, and so on.
  704.    In particular, you should run most utility programs via variables.
  705. Thus, if you use Bison, have a variable named `BISON' whose default
  706. value is set with `BISON = bison', and refer to it with `$(BISON)'
  707. whenever you need to use Bison.
  708.    File management utilities such as `ln', `rm', `mv', and so on, need
  709. not be referred to through variables in this way, since users don't
  710. need to replace them with other programs.
  711.    Each program-name variable should come with an options variable that
  712. is used to supply options to the program.  Append `FLAGS' to the
  713. program-name variable name to get the options variable name--for
  714. example, `BISONFLAGS'.  (The name `CFLAGS' is an exception to this
  715. rule, but we keep it because it is standard.)  Use `CPPFLAGS' in any
  716. compilation command that runs the preprocessor, and use `LDFLAGS' in
  717. any compilation command that does linking as well as in any direct use
  718. of `ld'.
  719.    If there are C compiler options that *must* be used for proper
  720. compilation of certain files, do not include them in `CFLAGS'.  Users
  721. expect to be able to specify `CFLAGS' freely themselves.  Instead,
  722. arrange to pass the necessary options to the C compiler independently
  723. of `CFLAGS', by writing them explicitly in the compilation commands or
  724. by defining an implicit rule, like this:
  725.      CFLAGS = -g
  726.      ALL_CFLAGS = -I. $(CFLAGS)
  727.      .c.o:
  728.              $(CC) -c $(CPPFLAGS) $(ALL_CFLAGS) $<
  729.    Do include the `-g' option in `CFLAGS', because that is not
  730. *required* for proper compilation.  You can consider it a default that
  731. is only recommended.  If the package is set up so that it is compiled
  732. with GCC by default, then you might as well include `-O' in the default
  733. value of `CFLAGS' as well.
  734.    Put `CFLAGS' last in the compilation command, after other variables
  735. containing compiler options, so the user can use `CFLAGS' to override
  736. the others.
  737.    Every Makefile should define the variable `INSTALL', which is the
  738. basic command for installing a file into the system.
  739.    Every Makefile should also define the variables `INSTALL_PROGRAM'
  740. and `INSTALL_DATA'.  (The default for each of these should be
  741. `$(INSTALL)'.)  Then it should use those variables as the commands for
  742. actual installation, for executables and nonexecutables respectively.
  743. Use these variables as follows:
  744.      $(INSTALL_PROGRAM) foo $(bindir)/foo
  745.      $(INSTALL_DATA) libfoo.a $(libdir)/libfoo.a
  746. Always use a file name, not a directory name, as the second argument of
  747. the installation commands.  Use a separate command for each file to be
  748. installed.
  749.