1 \input texinfo @c -*-texinfo-*-
3 @setfilename automake.info
5 @documentencoding UTF-8
12 @c @ovar(ARG, DEFAULT)
13 @c -------------------
14 @c The ARG is an optional argument. To be used for macro arguments in
15 @c their documentation (@defmac).
17 @r{[}@var{\varname\}@r{]}
20 @set PACKAGE_BUGREPORT bug-automake@@gnu.org
24 This manual is for GNU Automake (version @value{VERSION},
25 @value{UPDATED}), a program that creates GNU standards-compliant
26 Makefiles from template files.
28 Copyright @copyright{} 1995--2024 Free Software Foundation, Inc.
31 Permission is granted to copy, distribute and/or modify this document
32 under the terms of the GNU Free Documentation License,
33 Version 1.3 or any later version published by the Free Software
34 Foundation; with no Invariant Sections, with no Front-Cover texts,
35 and with no Back-Cover Texts. A copy of the license is included in the
36 section entitled ``GNU Free Documentation License.''
41 @dircategory Software development
43 * Automake: (automake). Making GNU standards-compliant Makefiles.
46 @dircategory Individual utilities
48 * aclocal-invocation: (automake)aclocal Invocation. Generating aclocal.m4.
49 * automake-invocation: (automake)automake Invocation. Generating Makefile.in.
54 @subtitle For version @value{VERSION}, @value{UPDATED}
55 @author David MacKenzie
57 @author Alexandre Duret-Lutz
58 @author Ralf Wildenhues
59 @author Stefano Lattarini
61 @vskip 0pt plus 1filll
68 @c We use the following macros to define indices:
69 @c @cindex concepts, and anything that does not fit elsewhere
70 @c @vindex Makefile variables
72 @c @acindex Autoconf/Automake/Libtool/M4/... macros
73 @c @opindex tool options
75 @c Define an index of configure macros.
77 @c Define an index of options.
79 @c Define an index of targets.
81 @c Define an index of commands.
84 @c Put the macros in the function index.
87 @c Put everything else into one index (arbitrarily chosen to be the
95 @comment node-name, next, previous, up
101 * Introduction:: Automake's purpose
102 * Autotools Introduction:: An Introduction to the Autotools
103 * Generalities:: General ideas
104 * Examples:: Some example packages
105 * automake Invocation:: Creating a Makefile.in
106 * configure:: Scanning configure.ac, using aclocal
107 * Directories:: Declaring subdirectories
108 * Programs:: Building programs and libraries
109 * Other Objects:: Other derived objects
110 * Other GNU Tools:: Other GNU Tools
111 * Documentation:: Building documentation
112 * Install:: What gets installed
113 * Clean:: What gets cleaned
114 * Dist:: What goes in a distribution
115 * Tests:: Support for test suites
116 * Rebuilding:: Automatic rebuilding of Makefile
117 * Options:: Changing Automake's behavior
118 * Miscellaneous:: Miscellaneous rules
119 * Include:: Including extra files in an Automake template
120 * Conditionals:: Conditionals
121 * Silencing Make:: Obtain less verbose output from @command{make}
122 * Not Enough:: When Automake is not Enough
123 * Distributing:: Distributing the Makefile.in
124 * API Versioning:: About compatibility between Automake versions
125 * Upgrading:: Upgrading to a Newer Automake Version
126 * FAQ:: Frequently Asked Questions
127 * Copying This Manual:: How to make copies of this manual
128 * Indices:: Indices of variables, macros, and concepts
131 --- The Detailed Node Listing ---
133 An Introduction to the Autotools
135 * GNU Build System:: Introducing the GNU Build System
136 * Use Cases:: Use Cases for the GNU Build System
137 * Why Autotools:: How Autotools Help
138 * Hello World:: A Small Hello World Package
140 Use Cases for the GNU Build System
142 * Basic Installation:: Common installation procedure
143 * Standard Targets:: A list of standard Makefile targets
144 * Standard Directory Variables:: A list of standard directory variables
145 * Standard Configuration Variables:: Using configuration variables
146 * config.site:: Using a config.site file
147 * VPATH Builds:: Parallel build trees
148 * Two-Part Install:: Installing data and programs separately
149 * Cross-Compilation:: Building for other architectures
150 * Renaming:: Renaming programs at install time
151 * DESTDIR:: Building binary packages with DESTDIR
152 * Preparing Distributions:: Rolling out tarballs
153 * Dependency Tracking:: Automatic dependency tracking
154 * Nested Packages:: The GNU Build Systems can be nested
158 * Creating amhello:: Create @file{amhello-1.0.tar.gz} from scratch
159 * amhello's configure.ac Setup Explained::
160 * amhello's Makefile.am Setup Explained::
164 * General Operation:: General operation of Automake
165 * Strictness:: Standards conformance checking
166 * Uniform:: The Uniform Naming Scheme
167 * Length Limitations:: Staying below the command line length limit
168 * Canonicalization:: How derived variables are named
169 * User Variables:: Variables reserved for the user
170 * Auxiliary Programs:: Programs automake might require
172 Some example packages
174 * Complete:: A simple example, start to finish
175 * true:: Building true and false
177 Scanning @file{configure.ac}, using @command{aclocal}
179 * Requirements:: Configuration requirements
180 * Optional:: Other things Automake recognizes
181 * aclocal Invocation:: Auto-generating aclocal.m4
182 * Macros:: Autoconf macros supplied with Automake
184 Auto-generating aclocal.m4
186 * aclocal Options:: Options supported by aclocal
187 * Macro Search Path:: How aclocal finds .m4 files
188 * Extending aclocal:: Writing your own aclocal macros
189 * Local Macros:: Organizing local macros
190 * Serials:: Serial lines in Autoconf macros
191 * Future of aclocal:: aclocal's scheduled death
193 Autoconf macros supplied with Automake
195 * Public Macros:: Macros that you can use.
196 * Obsolete Macros:: Macros that will soon be removed.
197 * Private Macros:: Macros that you should not use.
201 * Subdirectories:: Building subdirectories recursively
202 * Conditional Subdirectories:: Conditionally not building directories
203 * Alternative:: Subdirectories without recursion
204 * Subpackages:: Nesting packages
206 Conditional Subdirectories
208 * SUBDIRS vs DIST_SUBDIRS:: Two sets of directories
209 * Subdirectories with AM_CONDITIONAL:: Specifying conditional subdirectories
210 * Subdirectories with AC_SUBST:: Another way for conditional recursion
211 * Unconfigured Subdirectories:: Not even creating a @samp{Makefile}
213 Building Programs and Libraries
215 * A Program:: Building a program
216 * A Library:: Building a library
217 * A Shared Library:: Building a Libtool library
218 * Program and Library Variables:: Variables controlling program and
220 * Default _SOURCES:: Default source files
221 * LIBOBJS:: Special handling for LIBOBJS and ALLOCA
222 * Program Variables:: Variables used when building a program
223 * Yacc and Lex:: Yacc and Lex support
224 * C++ Support:: Compiling C++ sources
225 * Objective C Support:: Compiling Objective C sources
226 * Objective C++ Support:: Compiling Objective C++ sources
227 * Unified Parallel C Support:: Compiling Unified Parallel C sources
228 * Assembly Support:: Compiling assembly sources
229 * Fortran 77 Support:: Compiling Fortran 77 sources
230 * Fortran 9x Support:: Compiling Fortran 9x sources
231 * Java Support with gcj:: Compiling Java sources using gcj
232 * Vala Support:: Compiling Vala sources
233 * Support for Other Languages:: Compiling other languages
234 * Dependencies:: Automatic dependency tracking
235 * EXEEXT:: Support for executable extensions
239 * Program Sources:: Defining program sources
240 * Linking:: Linking with libraries or extra objects
241 * Conditional Sources:: Handling conditional sources
242 * Conditional Programs:: Building a program conditionally
244 Building a Shared Library
246 * Libtool Concept:: Introducing Libtool
247 * Libtool Libraries:: Declaring Libtool Libraries
248 * Conditional Libtool Libraries:: Building Libtool Libraries Conditionally
249 * Conditional Libtool Sources:: Choosing Library Sources Conditionally
250 * Libtool Convenience Libraries:: Building Convenience Libtool Libraries
251 * Libtool Modules:: Building Libtool Modules
252 * Libtool Flags:: Using _LIBADD, _LDFLAGS, and _LIBTOOLFLAGS
253 * LTLIBOBJS:: Using $(LTLIBOBJS) and $(LTALLOCA)
254 * Libtool Issues:: Common Issues Related to Libtool's Use
256 Common Issues Related to Libtool's Use
258 * Error required file ltmain.sh not found:: The need to run libtoolize
259 * Objects created both with libtool and without:: Avoid a specific build race
263 * Linking Multiple Yacc Parsers::
267 * Preprocessing Fortran 77:: Preprocessing Fortran 77 sources
268 * Compiling Fortran 77 Files:: Compiling Fortran 77 sources
269 * Mixing Fortran 77 With C and C++:: Mixing Fortran 77 With C and C++
271 Mixing Fortran 77 With C and C++
273 * How the Linker is Chosen:: Automatic linker selection
277 * Compiling Fortran 9x Files:: Compiling Fortran 9x sources
279 Other Derived Objects
281 * Scripts:: Executable scripts
282 * Headers:: Header files
283 * Data:: Architecture-independent data files
284 * Sources:: Derived sources
288 * Built Sources Example:: Several ways to handle built sources.
292 * Emacs Lisp:: Emacs Lisp
295 * Java:: Java bytecode compilation (deprecated)
300 * Supported Python versions::
302 Building documentation
305 * Man Pages:: Man pages
309 * Basics of Installation:: What gets installed where
310 * The Two Parts of Install:: Installing data and programs separately
311 * Extending Installation:: Adding your own rules for installation
312 * Staged Installs:: Installation in a temporary location
313 * Install Rules for the User:: Useful additional rules
315 What Goes in a Distribution
317 * Basics of Distribution:: Files distributed by default
318 * Fine-grained Distribution Control:: @code{dist_} and @code{nodist_} prefixes
319 * The dist Hook:: A target for last-minute distribution changes
320 * Checking the Distribution:: @samp{make distcheck} explained
321 * The Types of Distributions:: A variety of formats and compression methods
323 Checking the Distribution
325 * DISTCHECK_CONFIGURE_FLAGS:: Overriding configure flags in distcheck.
326 * distcheck-hook:: Running commands after distcheck.
327 * dvi and distcheck:: Overriding the distcheck doc target.
328 * distcleancheck:: Handling files not cleaned.
329 * distuninstallcheck:: Overriding the uninstall check.
330 * Errors with distclean::
332 Support for test suites
334 * Generalities about Testing:: Concepts and terminology about testing
335 * Simple Tests:: Listing test scripts in @code{TESTS}
336 * Custom Test Drivers:: Writing and using custom test drivers
337 * Using the TAP test protocol:: Integrating test scripts that use the TAP protocol
338 * DejaGnu Tests:: Interfacing with the @command{dejagnu} testing framework
339 * Install Tests:: Running tests on installed packages
343 * Scripts-based Testsuites:: Automake-specific concepts and terminology
344 * Serial Test Harness:: Older (and discouraged) serial test harness
345 * Parallel Test Harness:: Generic concurrent test harness
347 Scripts-based Testsuites
349 * Testsuite Environment Overrides::
353 * Overview of Custom Test Drivers Support::
354 * Declaring Custom Test Drivers::
355 * API for Custom Test Drivers::
357 API for Custom Test Drivers
359 * Command-line arguments for test drivers::
360 * Log files generation and test results recording::
361 * Testsuite progress output::
363 Using the TAP test protocol
365 * Introduction to TAP::
366 * Use TAP with the Automake test harness::
367 * Incompatibilities with other TAP parsers and drivers::
368 * Links and external resources on TAP::
370 Changing Automake's Behavior
372 * Options generalities:: Semantics of Automake option
373 * List of Automake options:: A comprehensive list of Automake options
377 * Tags:: Interfacing to cscope, etags and mkid
378 * Suffixes:: Handling new file extensions
382 * Usage of Conditionals:: Declaring conditional content
383 * Limits of Conditionals:: Enclosing complete statements
385 Silencing @command{make}
387 * Make verbosity:: Make is verbose by default
388 * Tricks For Silencing Make:: Standard and generic ways to silence make
389 * Automake Silent Rules:: How Automake can help in silencing make
390 * Unsilencing Automake:: Showing commands.
392 When Automake Isn't Enough
394 * Extending:: Adding new rules or overriding existing ones.
395 * Third-Party Makefiles:: Integrating Non-Automake @file{Makefile}s.
397 Frequently Asked Questions about Automake
399 * CVS:: CVS and generated files
400 * maintainer-mode:: missing and AM_MAINTAINER_MODE
401 * Wildcards:: Why doesn't Automake support wildcards?
402 * Limitations on File Names:: Limitations on source and installed file names
403 * Flag Variables Ordering:: CFLAGS vs.@: AM_CFLAGS vs.@: mumble_CFLAGS
404 * Renamed Objects:: Why are object files sometimes renamed?
405 * Per-Object Flags:: How to simulate per-object flags?
406 * Multiple Outputs:: Writing rules for tools with many output files
407 * Hard-Coded Install Paths:: Installing to hard-coded locations
408 * Debugging Make Rules:: Strategies when things don't work as expected
409 * Reporting Bugs:: Feedback on bugs and feature requests
413 * GNU Free Documentation License:: License for copying this manual
417 * Macro Index:: Index of Autoconf macros
418 * Variable Index:: Index of Makefile variables
419 * General Index:: General index
428 @chapter Introduction
430 Automake is a tool for automatically generating @file{Makefile.in}s
431 from files called @file{Makefile.am}. Each @file{Makefile.am} is
432 basically a series of @command{make} variable
433 definitions@footnote{These variables are also called @dfn{make macros}
434 in Make terminology, however in this manual we reserve the term
435 @dfn{macro} for Autoconf's macros.}, with rules being thrown in
436 occasionally. The generated @file{Makefile.in}s are compliant with
437 the GNU Makefile standards.
439 @cindex GNU Makefile standards
441 The GNU Makefile Standards Document
442 (@pxref{Makefile Conventions, , , standards, The GNU Coding Standards})
443 is long, complicated, and subject to change. The goal of Automake is to
444 remove the burden of Makefile maintenance from the back of the
445 individual GNU maintainer (and put it on the back of the Automake
448 The typical Automake input file is simply a series of variable definitions.
449 Each such file is processed to create a @file{Makefile.in}.
451 @cindex Constraints of Automake
452 @cindex Automake constraints
454 Automake does constrain a project in certain ways; for instance, it
455 assumes that the project uses Autoconf (@pxref{Top, , Introduction,
456 autoconf, The Autoconf Manual}), and enforces certain restrictions on
457 the @file{configure.ac} contents.
459 @cindex Automake requirements
460 @cindex Requirements, Automake
462 Automake requires @command{perl} in order to generate the
463 @file{Makefile.in}s. However, the distributions created by Automake are
464 fully GNU standards-compliant, and do not require @command{perl} in order
467 For more information on bug reports, @xref{Reporting Bugs}.
469 @node Autotools Introduction
470 @chapter An Introduction to the Autotools
472 If you are new to Automake, maybe you know that it is part of a set of
473 tools called @emph{The Autotools}. Maybe you've already delved into a
474 package full of files named @file{configure}, @file{configure.ac},
475 @file{Makefile.in}, @file{Makefile.am}, @file{aclocal.m4}, @dots{},
476 some of them claiming to be @emph{generated by} Autoconf or Automake.
477 But the exact purpose of these files and their relations is probably
478 fuzzy. The goal of this chapter is to introduce you to this machinery,
479 to show you how it works and how powerful it is. If you've never
480 installed or seen such a package, do not worry: this chapter will walk
483 If you need some teaching material, more illustrations, or a less
484 @command{automake}-centered continuation, some slides for this
485 introduction are available in Alexandre Duret-Lutz's
486 @uref{https://www.lrde.epita.fr/@/~adl/@/autotools.html,
488 This chapter is the written version of the first part of his tutorial.
491 * GNU Build System:: Introducing the GNU Build System
492 * Use Cases:: Use Cases for the GNU Build System
493 * Why Autotools:: How Autotools Help
494 * Hello World:: A Small Hello World Package
497 @node GNU Build System
498 @section Introducing the GNU Build System
499 @cindex GNU Build System, introduction
501 It is a truth universally acknowledged, that as a developer in
502 possession of a new package, you must be in want of a build system.
504 In the Unix world, such a build system is traditionally achieved using
505 the command @command{make} (@pxref{Top, , Overview, make, The GNU Make
506 Manual}). You express the recipe to build your package in a
507 @file{Makefile}. This file is a set of rules to build the files in
508 the package. For instance the program @file{prog} may be built by
509 running the linker on the files @file{main.o}, @file{foo.o}, and
510 @file{bar.o}; the file @file{main.o} may be built by running the
511 compiler on @file{main.c}; etc. Each time @command{make} is run, it
512 reads @file{Makefile}, checks the existence and modification time of
513 the files mentioned, decides what files need to be built (or rebuilt),
514 and runs the associated commands.
516 When a package needs to be built on a different platform than the one
517 it was developed on, its @file{Makefile} usually needs to be adjusted.
518 For instance the compiler may have another name or require more
519 options. In 1991, David J. MacKenzie got tired of customizing
520 @file{Makefile} for the 20 platforms he had to deal with. Instead, he
521 handcrafted a little shell script called @file{configure} to
522 automatically adjust the @file{Makefile} (@pxref{Genesis, , Genesis,
523 autoconf, The Autoconf Manual}). Compiling his package was now
524 as simple as running @code{./configure && make}.
526 @cindex GNU Coding Standards
528 Today this process has been standardized in the GNU project. The GNU
529 Coding Standards (@pxref{Managing Releases, The Release Process, ,
530 standards, The GNU Coding Standards}) explains how each package of the
531 GNU project should have a @file{configure} script, and the minimal
532 interface it should have. The @file{Makefile} too should follow some
533 established conventions. The result? A unified build system that
534 makes all packages almost indistinguishable by the installer. In its
535 simplest scenario, all the installer has to do is to unpack the
536 package, run @code{./configure && make && make install}, and repeat
537 with the next package to install.
539 We call this build system the @dfn{GNU Build System}, since it was
540 grown out of the GNU project. However it is used by a vast number of
541 other packages: following any existing convention has its advantages.
543 @cindex Autotools, introduction
545 The Autotools are tools that will create a GNU Build System for your
546 package. Autoconf mostly focuses on @file{configure} and Automake on
547 @file{Makefile}s. It is entirely possible to create a GNU Build
548 System without the help of these tools. However it is rather
549 burdensome and error-prone. We will discuss this again after some
550 illustration of the GNU Build System in action.
553 @section Use Cases for the GNU Build System
554 @cindex GNU Build System, use cases
555 @cindex GNU Build System, features
556 @cindex Features of the GNU Build System
557 @cindex Use Cases for the GNU Build System
558 @cindex @file{amhello-1.0.tar.gz}, location
559 @cindex @file{amhello-1.0.tar.gz}, use cases
561 In this section we explore several use cases for the GNU Build System.
562 You can replay all of these examples on the @file{amhello-1.0.tar.gz}
563 package distributed with Automake. If Automake is installed on your
564 system, you should find a copy of this file in
565 @file{@var{prefix}/share/doc/automake/amhello-1.0.tar.gz}, where
566 @var{prefix} is the installation prefix specified during configuration
567 (@var{prefix} defaults to @file{/usr/local}, however if Automake was
568 installed by some GNU/Linux distribution it most likely has been set
569 to @file{/usr}). If you do not have a copy of Automake installed,
570 you can find a copy of this file inside the @file{doc/} directory of
571 the Automake package.
573 Some of the following use cases present features that are in fact
574 extensions to the GNU Build System. Read: they are not specified by
575 the GNU Coding Standards, but they are nonetheless part of the build
576 system created by the Autotools. To keep things simple, we do not
577 point out the difference. Our objective is to show you many of the
578 features that the build system created by the Autotools will offer to
582 * Basic Installation:: Common installation procedure
583 * Standard Targets:: A list of standard Makefile targets
584 * Standard Directory Variables:: A list of standard directory variables
585 * Standard Configuration Variables:: Using configuration variables
586 * config.site:: Using a config.site file
587 * VPATH Builds:: Parallel build trees
588 * Two-Part Install:: Installing data and programs separately
589 * Cross-Compilation:: Building for other architectures
590 * Renaming:: Renaming programs at install time
591 * DESTDIR:: Building binary packages with DESTDIR
592 * Preparing Distributions:: Rolling out tarballs
593 * Dependency Tracking:: Automatic dependency tracking
594 * Nested Packages:: The GNU Build Systems can be nested
597 @node Basic Installation
598 @subsection Basic Installation
599 @cindex Configuration, basics
600 @cindex Installation, basics
601 @cindex GNU Build System, basics
603 The most common installation procedure looks as follows.
606 ~ % @kbd{tar zxf amhello-1.0.tar.gz}
607 ~ % @kbd{cd amhello-1.0}
608 ~/amhello-1.0 % @kbd{./configure}
610 config.status: creating Makefile
611 config.status: creating src/Makefile
613 ~/amhello-1.0 % @kbd{make}
615 ~/amhello-1.0 % @kbd{make check}
617 ~/amhello-1.0 % @kbd{su}
619 /home/adl/amhello-1.0 # @kbd{make install}
621 /home/adl/amhello-1.0 # @kbd{exit}
622 ~/amhello-1.0 % @kbd{make installcheck}
628 The user first unpacks the package. Here, and in the following
629 examples, we will use the non-portable @code{tar zxf} command for
630 simplicity. On a system without GNU @command{tar} installed, this
631 command should read @code{gunzip -c amhello-1.0.tar.gz | tar xf -}.
633 The user then enters the newly created directory to run the
634 @file{configure} script. This script probes the system for various
635 features, and finally creates the @file{Makefile}s. In this toy
636 example there are only two @file{Makefile}s, but in real-world projects,
637 there may be many more, usually one @file{Makefile} per directory.
639 It is now possible to run @code{make}. This will construct all the
640 programs, libraries, and scripts that need to be constructed for the
641 package. In our example, this compiles the @file{hello} program.
642 All files are constructed in place, in the source tree; we will see
643 later how this can be changed.
645 @code{make check} causes the package's tests to be run. This step is
646 not mandatory, but it is often good to make sure the programs that
647 have been built behave as they should, before you decide to install
648 them. Our example does not contain any tests, so running @code{make
651 @cindex su, before @code{make install}
652 After everything has been built, and maybe tested, it is time to
653 install it on the system. That means copying the programs,
654 libraries, header files, scripts, and other data files from the
655 source directory to their final destination on the system. The
656 command @code{make install} will do that. However, by default
657 everything will be installed in subdirectories of @file{/usr/local}:
658 binaries will go into @file{/usr/local/bin}, libraries will end up in
659 @file{/usr/local/lib}, etc. This destination is usually not writable
660 by any user, so we assume that we have to become root before we can
661 run @code{make install}. In our example, running @code{make install}
662 will copy the program @file{hello} into @file{/usr/local/bin}
663 and @file{README} into @file{/usr/local/share/doc/amhello}.
665 A last and optional step is to run @code{make installcheck}. This
666 command may run tests on the installed files. @code{make check} tests
667 the files in the source tree, while @code{make installcheck} tests
668 their installed copies. The tests run by the latter can be different
669 from those run by the former. For instance, there are tests that
670 cannot be run in the source tree. Conversely, some packages are set
671 up so that @code{make installcheck} will run the very same tests as
672 @code{make check}, only on different files (non-installed
673 vs.@: installed). It can make a difference, for instance when the
674 source tree's layout is different from that of the installation.
675 Furthermore it may help to diagnose an incomplete installation.
677 Presently most packages do not have any @code{installcheck} tests
678 because the existence of @code{installcheck} is little known, and its
679 usefulness is neglected. Our little toy package is no better: @code{make
680 installcheck} does nothing.
682 @node Standard Targets
683 @subsection Standard @file{Makefile} Targets
685 So far we have come across four ways to run @command{make} in the GNU
686 Build System: @code{make}, @code{make check}, @code{make install}, and
687 @code{make installcheck}. The words @code{check}, @code{install}, and
688 @code{installcheck}, passed as arguments to @command{make}, are called
689 @dfn{targets}. @code{make} is a shorthand for @code{make all},
690 @code{all} being the default target in the GNU Build System.
692 Here is a list of the most useful targets that the GNU Coding Standards
698 Build programs, libraries, documentation, etc.@: (same as @code{make}).
701 Install what needs to be installed, copying the files from the
702 package's tree to system-wide directories.
703 @item make install-strip
704 @trindex install-strip
705 Same as @code{make install}, then strip debugging symbols. Some
706 users like to trade space for useful bug reports@enddots{}
709 The opposite of @code{make install}: erase the installed files.
710 (This needs to be run from the same build tree that was installed.)
713 Erase from the build tree the files built by @code{make all}.
716 Additionally erase anything @code{./configure} created.
719 Run the test suite, if any.
720 @item make installcheck
721 @trindex installcheck
722 Check the installed programs or libraries, if supported.
725 Recreate @file{@var{package}-@var{version}.tar.gz} from all the source
729 @node Standard Directory Variables
730 @subsection Standard Directory Variables
731 @cindex directory variables
733 The GNU Coding Standards also specify a hierarchy of variables to
734 denote installation directories. Some of these are:
736 @multitable {Directory variable} {@code{$@{datarootdir@}/doc/$@{PACKAGE@}}}
737 @headitem Directory variable @tab Default value
738 @item @code{prefix} @tab @code{/usr/local}
739 @item @w{@ @ @code{exec_prefix}} @tab @code{$@{prefix@}}
740 @item @w{@ @ @ @ @code{bindir}} @tab @code{$@{exec_prefix@}/bin}
741 @item @w{@ @ @ @ @code{libdir}} @tab @code{$@{exec_prefix@}/lib}
742 @item @w{@ @ @ @ @dots{}}
743 @item @w{@ @ @code{includedir}} @tab @code{$@{prefix@}/include}
744 @item @w{@ @ @code{datarootdir}} @tab @code{$@{prefix@}/share}
745 @item @w{@ @ @ @ @code{datadir}} @tab @code{$@{datarootdir@}}
746 @item @w{@ @ @ @ @code{mandir}} @tab @code{$@{datarootdir@}/man}
747 @item @w{@ @ @ @ @code{infodir}} @tab @code{$@{datarootdir@}/info}
748 @item @w{@ @ @ @ @code{docdir}} @tab @code{$@{datarootdir@}/doc/$@{PACKAGE@}}
749 @item @w{@ @ @dots{}}
752 @c We should provide a complete table somewhere, but not here. The
753 @c complete list of directory variables it too confusing as-is. It
754 @c requires some explanations that are too complicated for this
755 @c introduction. Besides listing directories like localstatedir
756 @c would make the explanations in ``Two-Part Install'' harder.
758 Each of these directories has a role which is often obvious from its
759 name. In a package, any installable file will be installed in one of
760 these directories. For instance in @code{amhello-1.0}, the program
761 @file{hello} is to be installed in @var{bindir}, the directory for
762 binaries. The default value for this directory is
763 @file{/usr/local/bin}, but the user can supply a different value when
764 calling @command{configure}. Also the file @file{README} will be
765 installed into @var{docdir}, which defaults to
766 @file{/usr/local/share/doc/amhello}.
770 As a user, if you wish to install a package on your own account, you
771 could proceed as follows:
774 ~/amhello-1.0 % @kbd{./configure --prefix ~/usr}
776 ~/amhello-1.0 % @kbd{make}
778 ~/amhello-1.0 % @kbd{make install}
782 This would install @file{~/usr/bin/hello} and
783 @file{~/usr/share/doc/amhello/README}.
785 The list of all such directory options is shown by
786 @code{./configure --help}.
788 @node Standard Configuration Variables
789 @subsection Standard Configuration Variables
790 @cindex configuration variables, overriding
792 The GNU Coding Standards also define a set of standard configuration
793 variables used during the build. Here are some:
802 @item @code{CXXFLAGS}
806 @item @code{CPPFLAGS}
807 C/C++ preprocessor flags
811 @command{configure} usually does a good job at setting appropriate
812 values for these variables, but there are cases where you may want to
813 override them. For instance you may have several versions of a
814 compiler installed and would like to use another one, you may have
815 header files installed outside the default search path of the
816 compiler, or even libraries out of the way of the linker.
818 Here is how one would call @command{configure} to force it to use
819 @command{gcc-3} as C compiler, use header files from
820 @file{~/usr/include} when compiling, and libraries from
821 @file{~/usr/lib} when linking.
824 ~/amhello-1.0 % @kbd{./configure --prefix ~/usr CC=gcc-3 \
825 CPPFLAGS=-I$HOME/usr/include LDFLAGS=-L$HOME/usr/lib}
828 Again, a full list of these variables appears in the output of
829 @code{./configure --help}.
832 @subsection Overriding Default Configuration Setting with @file{config.site}
833 @cindex @file{config.site} example
835 When installing several packages using the same setup, it can be
836 convenient to create a file to capture common settings.
837 If a file named @file{@var{prefix}/share/config.site} exists,
838 @command{configure} will source it at the beginning of its execution.
840 Recall the command from the previous section:
843 ~/amhello-1.0 % @kbd{./configure --prefix ~/usr CC=gcc-3 \
844 CPPFLAGS=-I$HOME/usr/include LDFLAGS=-L$HOME/usr/lib}
847 Assuming we are installing many package in @file{~/usr}, and will
848 always want to use these definitions of @code{CC}, @code{CPPFLAGS}, and
849 @code{LDFLAGS}, we can automate this by creating the following
850 @file{~/usr/share/config.site} file:
853 test -z "$CC" && CC=gcc-3
854 test -z "$CPPFLAGS" && CPPFLAGS=-I$HOME/usr/include
855 test -z "$LDFLAGS" && LDFLAGS=-L$HOME/usr/lib
858 Now, any time a @file{configure} script is using the @file{~/usr}
859 prefix, it will execute the above @file{config.site} and define
860 these three variables.
863 ~/amhello-1.0 % @kbd{./configure --prefix ~/usr}
864 configure: loading site script /home/adl/usr/share/config.site
868 @xref{Site Defaults, , Setting Site Defaults, autoconf, The Autoconf
869 Manual}, for more information about this feature.
873 @subsection Parallel Build Trees (a.k.a.@: VPATH Builds)
874 @cindex Parallel build trees
876 @cindex source tree and build tree
877 @cindex build tree and source tree
878 @cindex trees, source vs.@: build
880 The GNU Build System distinguishes two trees: the source tree, and
881 the build tree. These are two directories that may be the same, or
884 The source tree is rooted in the directory containing the
885 @file{configure} script. It contains all the source files (those that are
886 distributed), and may be arranged using several subdirectories.
888 The build tree is rooted in the current directory at the time @file{configure}
889 was run, and is populated with all object files, programs, libraries,
890 and other derived files built from the sources (and hence not
891 distributed). The build tree usually has the same subdirectory layout
892 as the source tree; its subdirectories are created automatically by
895 If @file{configure} is executed in its own directory, the source and
896 build trees are combined: derived files are constructed in the same
897 directories as their sources. This was the case in our first
898 installation example (@pxref{Basic Installation}).
900 A common request from users is that they want to confine all derived
901 files to a single directory, to keep their source directories
902 uncluttered. Here is how we could run @file{configure} to create
903 everything in a build tree (that is, subdirectory) called @file{build/}.
906 ~ % @kbd{tar zxf ~/amhello-1.0.tar.gz}
907 ~ % @kbd{cd amhello-1.0}
908 ~/amhello-1.0 % @kbd{mkdir build && cd build}
909 ~/amhello-1.0/build % @kbd{../configure}
911 ~/amhello-1.0/build % @kbd{make}
915 These setups, where source and build trees are different, are often
916 called @dfn{parallel builds} or @dfn{VPATH builds}. The expression
917 @emph{parallel build} is misleading: the word @emph{parallel} is a
918 reference to the way the build tree shadows the source tree, it is not
919 about some concurrency in the way build commands are run. For this
920 reason we refer to such setups using the name @emph{VPATH builds} in
921 the following. @emph{VPATH} is the name of the @command{make} feature
922 used by the @file{Makefile}s to allow these builds (@pxref{General
923 Search, , @code{VPATH} Search Path for All Prerequisites, make, The
926 @cindex multiple configurations, example
927 @cindex debug build, example
928 @cindex optimized build, example
930 VPATH builds have other interesting uses. One is to build the same
931 sources with multiple configurations. For instance:
933 @c Keep in sync with amhello-cflags.sh
935 ~ % @kbd{tar zxf ~/amhello-1.0.tar.gz}
936 ~ % @kbd{cd amhello-1.0}
937 ~/amhello-1.0 % @kbd{mkdir debug optim && cd debug}
938 ~/amhello-1.0/debug % @kbd{../configure CFLAGS='-g -O0'}
940 ~/amhello-1.0/debug % @kbd{make}
942 ~/amhello-1.0/debug % cd ../optim
943 ~/amhello-1.0/optim % @kbd{../configure CFLAGS='-O3 -fomit-frame-pointer'}
945 ~/amhello-1.0/optim % @kbd{make}
949 With network file systems, a similar approach can be used to build the
950 same sources on different machines. For instance, suppose that the
951 sources are installed on a directory shared by two hosts: @code{HOST1}
952 and @code{HOST2}, which may be different platforms.
955 ~ % @kbd{cd /nfs/src}
956 /nfs/src % @kbd{tar zxf ~/amhello-1.0.tar.gz}
959 On the first host, you could create a local build directory:
961 [HOST1] ~ % @kbd{mkdir /tmp/amh && cd /tmp/amh}
962 [HOST1] /tmp/amh % @kbd{/nfs/src/amhello-1.0/configure}
964 [HOST1] /tmp/amh % @kbd{make && sudo make install}
969 (Here we assume that the installer has configured @command{sudo} so it
970 can execute @code{make install} with root privileges; it is more convenient
971 than using @command{su} like in @ref{Basic Installation}).
973 On the second host, you would do exactly the same, possibly at
976 [HOST2] ~ % @kbd{mkdir /tmp/amh && cd /tmp/amh}
977 [HOST2] /tmp/amh % @kbd{/nfs/src/amhello-1.0/configure}
979 [HOST2] /tmp/amh % @kbd{make && sudo make install}
983 @cindex read-only source tree
984 @cindex source tree, read-only
986 In this scenario, nothing forbids the @file{/nfs/src/amhello-1.0}
987 directory from being read-only. In fact VPATH builds are also a means
988 of building packages from a read-only medium such as a CD-ROM. (The
989 FSF used to sell CD-ROMs with unpacked source code, before the GNU
990 project grew so big.)
992 @node Two-Part Install
993 @subsection Two-Part Installation
995 In our last example (@pxref{VPATH Builds}), a source tree was shared
996 by two hosts, but compilation and installation were done separately on
999 The GNU Build System also supports networked setups where part of the
1000 installed files should be shared amongst multiple hosts. It does so
1001 by distinguishing architecture-dependent files from
1002 architecture-independent files, and providing two @file{Makefile}
1003 targets to install each of these classes of files.
1005 @trindex install-exec
1006 @trindex install-data
1008 These targets are @code{install-exec} for architecture-dependent files
1009 and @code{install-data} for architecture-independent files.
1010 The command we used up to now, @code{make install}, can be thought of
1011 as a shorthand for @code{make install-exec install-data}.
1013 From the GNU Build System point of view, the distinction between
1014 architecture-dependent files and architecture-independent files is
1015 based exclusively on the directory variable used to specify their
1016 installation destination. In the list of directory variables we
1017 provided earlier (@pxref{Standard Directory Variables}), all the
1018 variables based on @var{exec-prefix} designate architecture-dependent
1019 directories whose files will be installed by @code{make install-exec}.
1020 The others designate architecture-independent directories and will
1021 serve files installed by @code{make install-data}. @xref{The Two Parts
1022 of Install}, for more details.
1024 Here is how we could revisit our two-host installation example,
1025 assuming that (1) we want to install the package directly in
1026 @file{/usr}, and (2) the directory @file{/usr/share} is shared by the
1029 On the first host we would run
1031 [HOST1] ~ % @kbd{mkdir /tmp/amh && cd /tmp/amh}
1032 [HOST1] /tmp/amh % @kbd{/nfs/src/amhello-1.0/configure --prefix /usr}
1034 [HOST1] /tmp/amh % @kbd{make && sudo make install}
1038 On the second host, however, we need only install the
1039 architecture-specific files.
1041 [HOST2] ~ % @kbd{mkdir /tmp/amh && cd /tmp/amh}
1042 [HOST2] /tmp/amh % @kbd{/nfs/src/amhello-1.0/configure --prefix /usr}
1044 [HOST2] /tmp/amh % @kbd{make && sudo make install-exec}
1048 In packages that have installation checks, it would make sense to run
1049 @code{make installcheck} (@pxref{Basic Installation}) to verify that
1050 the package works correctly despite the apparent partial installation.
1052 @node Cross-Compilation
1053 @subsection Cross-Compilation
1054 @cindex cross-compilation
1056 To @dfn{cross-compile} is to build on one platform a binary that will
1057 run on another platform. When speaking of cross-compilation, it is
1058 important to distinguish between the @dfn{build platform} on which
1059 the compilation is performed, and the @dfn{host platform} on which the
1060 resulting executable is expected to run. The following
1061 @command{configure} options are used to specify each of them:
1064 @item --build=@var{build}
1065 @opindex --build=@var{build}
1066 The system on which the package is built.
1067 @item --host=@var{host}
1068 @opindex --host=@var{host}
1069 The system where built programs and libraries will run.
1072 When the @option{--host} is used, @command{configure} will search for
1073 the cross-compiling suite for this platform. Cross-compilation tools
1074 commonly have their target architecture as prefix of their name. For
1075 instance my cross-compiler for MinGW32 has its binaries called
1076 @code{i586-mingw32msvc-gcc}, @code{i586-mingw32msvc-ld},
1077 @code{i586-mingw32msvc-as}, etc.
1079 @cindex MinGW cross-compilation example
1080 @cindex cross-compilation example
1082 Here is how we could build @code{amhello-1.0} for
1083 @code{i586-mingw32msvc} on a GNU/Linux PC.
1085 @c Keep in sync with amhello-cross-compile.sh
1087 ~/amhello-1.0 % @kbd{./configure --build i686-pc-linux-gnu --host i586-mingw32msvc}
1088 checking for a BSD-compatible install... /usr/bin/install -c
1089 checking whether build environment is sane... yes
1090 checking for gawk... gawk
1091 checking whether make sets $(MAKE)... yes
1092 checking for i586-mingw32msvc-strip... i586-mingw32msvc-strip
1093 checking for i586-mingw32msvc-gcc... i586-mingw32msvc-gcc
1094 checking for C compiler default output file name... a.exe
1095 checking whether the C compiler works... yes
1096 checking whether we are cross compiling... yes
1097 checking for suffix of executables... .exe
1098 checking for suffix of object files... o
1099 checking whether we are using the GNU C compiler... yes
1100 checking whether i586-mingw32msvc-gcc accepts -g... yes
1101 checking for i586-mingw32msvc-gcc option to accept ANSI C...
1103 ~/amhello-1.0 % @kbd{make}
1105 ~/amhello-1.0 % @kbd{cd src; file hello.exe}
1106 hello.exe: MS Windows PE 32-bit Intel 80386 console executable not relocatable
1109 The @option{--host} and @option{--build} options are usually all we
1110 need for cross-compiling. The only exception is if the package being
1111 built is itself a cross-compiler: we need a third option to specify
1112 its target architecture.
1115 @item --target=@var{target}
1116 @opindex --target=@var{target}
1117 When building compiler tools: the system for which the tools will
1121 For instance when installing GCC, the GNU Compiler Collection, we can
1122 use @option{--target=@/@var{target}} to specify that we want to build
1123 GCC as a cross-compiler for @var{target}. Mixing @option{--build} and
1124 @option{--target}, we can cross-compile a cross-compiler; such a
1125 three-way cross-compilation is known as a @dfn{Canadian cross}.
1127 @xref{Specifying Names, , Specifying the System Type, autoconf, The
1128 Autoconf Manual}, for more information about these @command{configure}
1132 @subsection Renaming Programs at Install Time
1133 @cindex Renaming programs
1134 @cindex Transforming program names
1135 @cindex Programs, renaming during installation
1137 The GNU Build System provides means to automatically rename
1138 executables and manpages before they are installed (@pxref{Man Pages}).
1139 This is especially convenient
1140 when installing a GNU package on a system that already has a
1141 proprietary implementation you do not want to overwrite. For instance,
1142 you may want to install GNU @command{tar} as @command{gtar} so you can
1143 distinguish it from your vendor's @command{tar}.
1145 This can be done using one of these three @command{configure} options.
1148 @item --program-prefix=@var{prefix}
1149 @opindex --program-prefix=@var{prefix}
1150 Prepend @var{prefix} to installed program names.
1151 @item --program-suffix=@var{suffix}
1152 @opindex --program-suffix=@var{suffix}
1153 Append @var{suffix} to installed program names.
1154 @item --program-transform-name=@var{program}
1155 @opindex --program-transform-name=@var{program}
1156 Run @code{sed @var{program}} on installed program names.
1159 The following commands would install @file{hello}
1160 as @file{/usr/local/bin/test-hello}, for instance.
1163 ~/amhello-1.0 % @kbd{./configure --program-prefix test-}
1165 ~/amhello-1.0 % @kbd{make}
1167 ~/amhello-1.0 % @kbd{sudo make install}
1172 @subsection Building Binary Packages Using DESTDIR
1175 The GNU Build System's @code{make install} and @code{make uninstall}
1176 interface does not exactly fit the needs of a system administrator
1177 who has to deploy and upgrade packages on lots of hosts. In other
1178 words, the GNU Build System does not replace a package manager.
1180 Such package managers usually need to know which files have been
1181 installed by a package, so a mere @code{make install} is
1184 @cindex Staged installation
1186 The @code{DESTDIR} variable can be used to perform a staged
1187 installation. The package should be configured as if it was going to
1188 be installed in its final location (e.g., @code{--prefix /usr}), but
1189 when running @code{make install}, the @code{DESTDIR} should be set to
1190 the absolute name of a directory into which the installation will be
1191 diverted. From this directory it is easy to review which files are
1192 being installed where, and finally copy them to their final location
1195 @cindex Binary package
1197 For instance here is how we could create a binary package containing a
1198 snapshot of all the files to be installed.
1200 @c Keep in sync with amhello-binpkg.sh
1202 ~/amhello-1.0 % @kbd{./configure --prefix /usr}
1204 ~/amhello-1.0 % @kbd{make}
1206 ~/amhello-1.0 % @kbd{make DESTDIR=$HOME/inst install}
1208 ~/amhello-1.0 % @kbd{cd ~/inst}
1209 ~/inst % @kbd{find . -type f -print > ../files.lst}
1210 ~/inst % @kbd{tar zcvf ~/amhello-1.0-i686.tar.gz `cat ../files.lst`}
1212 ./usr/share/doc/amhello/README
1215 After this example, @code{amhello-1.0-i686.tar.gz} is ready to be
1216 uncompressed in @file{/} on many hosts. (Using @code{`cat ../files.lst`}
1217 instead of @samp{.} as argument for @command{tar} avoids entries for
1218 each subdirectory in the archive: we would not like @command{tar} to
1219 restore the modification time of @file{/}, @file{/usr/}, etc.)
1221 Note that when building packages for several architectures, it might
1222 be convenient to use @code{make install-data} and @code{make
1223 install-exec} (@pxref{Two-Part Install}) to gather
1224 architecture-independent files in a single package.
1226 @xref{Install}, for more information.
1228 @c We should document PRE_INSTALL/POST_INSTALL/NORMAL_INSTALL and their
1229 @c UNINSTALL counterparts.
1231 @node Preparing Distributions
1232 @subsection Preparing Distributions
1233 @cindex Preparing distributions
1234 @cindex Packages, preparation
1235 @cindex Distributions, preparation
1237 We have already mentioned @code{make dist}. This target collects all
1238 your source files and the necessary parts of the build system to
1239 create a tarball named @file{@var{package}-@var{version}.tar.gz}.
1241 @cindex @code{distcheck} better than @code{dist}
1243 Another, more useful command is @code{make distcheck}. The
1244 @code{distcheck} target constructs
1245 @file{@var{package}-@var{version}.tar.gz} just as well as @code{dist},
1246 but it additionally ensures most of the use cases presented so far
1251 It attempts a full compilation of the package (@pxref{Basic
1252 Installation}): unpacking the newly constructed tarball, running
1253 @code{make}, @code{make dvi}, @code{make check}, @code{make install},
1254 as well as @code{make installcheck}, and even @code{make dist},
1256 it tests VPATH builds with read-only source tree (@pxref{VPATH Builds}),
1258 it makes sure @code{make clean}, @code{make distclean}, and @code{make
1259 uninstall} do not omit any file (@pxref{Standard Targets}),
1261 and it checks that @code{DESTDIR} installations work (@pxref{DESTDIR}).
1264 All of these actions are performed in a temporary directory, so that
1265 no root privileges are required. The exact location and the exact
1266 structure of such a subdirectory (where the extracted sources are
1267 placed, how the temporary build and install directories are named and
1268 how deeply they are nested, etc.) is to be considered an
1269 implementation detail, which can change at any time; so do not rely on
1272 Releasing a package that fails @code{make distcheck} means that one of
1273 the scenarios we presented will not work and some users will be
1274 disappointed. Therefore it is a good practice to release a package
1275 only after a successful @code{make distcheck}. This of course does
1276 not imply that the package will be flawless, but at least it will
1277 prevent some of the embarrassing errors you may find in packages
1278 released by people who have never heard about @code{distcheck} (like
1279 @code{DESTDIR} not working because of a typo, or a distributed file
1280 being erased by @code{make clean}, or even @code{VPATH} builds not
1283 @xref{Creating amhello}, to recreate @file{amhello-1.0.tar.gz} using
1284 @code{make distcheck}. @xref{Checking the Distribution}, for more
1285 information about @code{distcheck}.
1287 @node Dependency Tracking
1288 @subsection Automatic Dependency Tracking
1289 @cindex Dependency tracking
1291 Dependency tracking is performed as a side-effect of compilation.
1292 Each time the build system compiles a source file, it computes its
1293 list of dependencies (in C these are the header files included by the
1294 source being compiled). Later, any time @command{make} is run and a
1295 dependency appears to have changed, the dependent files will be
1298 Automake generates code for automatic dependency tracking by default,
1299 unless the developer chooses to override it; for more information,
1300 @pxref{Dependencies}.
1302 When @command{configure} is executed, you can see it probing each
1303 compiler for the dependency mechanism it supports (several mechanisms
1307 ~/amhello-1.0 % @kbd{./configure --prefix /usr}
1309 checking dependency style of gcc... gcc3
1313 Because dependencies are only computed as a side-effect of the
1314 compilation, no dependency information exists the first time a package
1315 is built. This is OK because all the files need to be built anyway:
1316 @code{make} does not have to decide which files need to be rebuilt.
1317 In fact, dependency tracking is completely useless for one-time builds
1318 and there is a @command{configure} option to disable this:
1321 @item --disable-dependency-tracking
1322 @opindex --disable-dependency-tracking
1323 Speed up one-time builds.
1326 Some compilers do not offer any practical way to derive the list of
1327 dependencies as a side-effect of the compilation, requiring a separate
1328 run (maybe of another tool) to compute these dependencies. The
1329 performance penalty implied by these methods is important enough to
1330 disable them by default. The option @option{--enable-dependency-tracking}
1331 must be passed to @command{configure} to activate them.
1334 @item --enable-dependency-tracking
1335 @opindex --enable-dependency-tracking
1336 Do not reject slow dependency extractors.
1339 @xref{Dependency Tracking Evolution, , Dependency Tracking Evolution,
1340 automake-history, Brief History of Automake}, for some discussion about
1341 the different dependency tracking schemes used by Automake over the years.
1343 @node Nested Packages
1344 @subsection Nested Packages
1345 @cindex Nested packages
1346 @cindex Packages, nested
1349 Although nesting packages isn't something we would recommend to
1350 someone who is discovering the Autotools, it is a nice feature worthy
1351 of mention in this small advertising tour.
1353 Autoconfiscated packages (that means packages whose build system have
1354 been created by Autoconf and friends) can be nested to arbitrary
1357 A typical setup is that package A will distribute one of the libraries
1358 it needs in a subdirectory. This library B is a complete package with
1359 its own GNU Build System. The @command{configure} script of A will
1360 run the @command{configure} script of B as part of its execution;
1361 building and installing A will also build and install B. Generating a
1362 distribution for A will also include B.
1364 It is possible to gather several packages like this. GCC is a heavy
1365 user of this feature. This gives installers a single package to
1366 configure, build and install, while it allows developers to work on
1367 subpackages independently.
1369 When configuring nested packages, the @command{configure} options
1370 given to the top-level @command{configure} are passed recursively to
1371 nested @command{configure}s. A package that does not understand an
1372 option will ignore it, assuming it is meaningful to some other
1375 @opindex --help=recursive
1377 The command @code{configure --help=recursive} can be used to display
1378 the options supported by all the included packages.
1380 @xref{Subpackages}, for an example setup.
1383 @section How Autotools Help
1384 @cindex Autotools, purpose
1386 There are several reasons why you may not want to implement the GNU
1387 Build System yourself (read: write a @file{configure} script and
1388 @file{Makefile}s yourself).
1392 As we have seen, the GNU Build System has a lot of
1393 features (@pxref{Use Cases}).
1394 Some users may expect features you have not implemented because
1395 you did not need them.
1397 Implementing these features portably is difficult and exhausting.
1398 Think of writing portable shell scripts, and portable
1399 @file{Makefile}s, for systems you may not have handy. @xref{Portable
1400 Shell, , Portable Shell Programming, autoconf, The Autoconf Manual}, to
1403 You will have to upgrade your setup to follow changes to the GNU
1407 The GNU Autotools take all this burden off your back and provide:
1411 Tools to create a portable, complete, and self-contained GNU Build
1412 System, from simple instructions.
1413 @emph{Self-contained} meaning the resulting build system does not
1414 require the GNU Autotools.
1416 A central place where fixes and improvements are made:
1417 a bug-fix for a portability issue will benefit every package.
1420 Yet there also exist reasons why you may want NOT to use the
1421 Autotools@enddots{} For instance you may be already using (or used to)
1422 another incompatible build system. Autotools will only be useful if
1423 you do accept the concepts of the GNU Build System. People who have their
1424 own idea of how a build system should work will feel frustrated by the
1428 @section A Small Hello World
1429 @cindex Example Hello World
1430 @cindex Hello World example
1431 @cindex @file{amhello-1.0.tar.gz}, creation
1433 In this section we recreate the @file{amhello-1.0} package from
1434 scratch. The first subsection shows how to call the Autotools to
1435 instantiate the GNU Build System, while the second explains the
1436 meaning of the @file{configure.ac} and @file{Makefile.am} files read
1439 @anchor{amhello Explained}
1441 * Creating amhello:: Create @file{amhello-1.0.tar.gz} from scratch
1442 * amhello's configure.ac Setup Explained::
1443 * amhello's Makefile.am Setup Explained::
1446 @node Creating amhello
1447 @subsection Creating @file{amhello-1.0.tar.gz}
1449 Here is how we can recreate @file{amhello-1.0.tar.gz} from scratch.
1450 The package is simple enough so that we will only need to write 5
1451 files. (You may copy them from the final @file{amhello-1.0.tar.gz}
1452 that is distributed with Automake if you do not want to write them.)
1454 Create the following files in an empty directory.
1459 @file{src/main.c} is the source file for the @file{hello} program. We
1460 store it in the @file{src/} subdirectory, because later, when the package
1461 evolves, it will ease the addition of a @file{man/} directory for man
1462 pages, a @file{data/} directory for data files, etc.
1464 ~/amhello % @kbd{cat src/main.c}
1471 puts ("Hello World!");
1472 puts ("This is " PACKAGE_STRING ".");
1478 @file{README} contains some very limited documentation for our little
1481 ~/amhello % @kbd{cat README}
1482 This is a demonstration package for GNU Automake.
1483 Type 'info Automake' to read the Automake manual.
1487 @file{Makefile.am} and @file{src/Makefile.am} contain Automake
1488 instructions for these two directories.
1491 ~/amhello % @kbd{cat src/Makefile.am}
1492 bin_PROGRAMS = hello
1493 hello_SOURCES = main.c
1494 ~/amhello % @kbd{cat Makefile.am}
1496 dist_doc_DATA = README
1500 Finally, @file{configure.ac} contains Autoconf instructions to
1501 create the @command{configure} script.
1504 ~/amhello % @kbd{cat configure.ac}
1505 AC_INIT([amhello], [1.0], [@value{PACKAGE_BUGREPORT}])
1506 AM_INIT_AUTOMAKE([-Wall -Werror foreign])
1508 AC_CONFIG_HEADERS([config.h])
1517 @cindex @command{autoreconf}, example
1519 Once you have these five files, it is time to run the Autotools to
1520 instantiate the build system. Do this using the @command{autoreconf}
1524 ~/amhello % @kbd{autoreconf --install}
1525 configure.ac: installing './install-sh'
1526 configure.ac: installing './missing'
1527 configure.ac: installing './compile'
1528 src/Makefile.am: installing './depcomp'
1531 At this point the build system is complete.
1533 In addition to the three scripts mentioned in its output, you can see
1534 that @command{autoreconf} created four other files: @file{configure},
1535 @file{config.h.in}, @file{Makefile.in}, and @file{src/Makefile.in}.
1536 The latter three files are templates that will be adapted to the
1537 system by @command{configure} under the names @file{config.h},
1538 @file{Makefile}, and @file{src/Makefile}. Let's do this:
1541 ~/amhello % @kbd{./configure}
1542 checking for a BSD-compatible install... /usr/bin/install -c
1543 checking whether build environment is sane... yes
1544 checking for gawk... no
1545 checking for mawk... mawk
1546 checking whether make sets $(MAKE)... yes
1547 checking for gcc... gcc
1548 checking for C compiler default output file name... a.out
1549 checking whether the C compiler works... yes
1550 checking whether we are cross compiling... no
1551 checking for suffix of executables...
1552 checking for suffix of object files... o
1553 checking whether we are using the GNU C compiler... yes
1554 checking whether gcc accepts -g... yes
1555 checking for gcc option to accept ISO C89... none needed
1556 checking for style of include used by make... GNU
1557 checking dependency style of gcc... gcc3
1558 configure: creating ./config.status
1559 config.status: creating Makefile
1560 config.status: creating src/Makefile
1561 config.status: creating config.h
1562 config.status: executing depfiles commands
1566 @cindex @code{distcheck} example
1568 You can see @file{Makefile}, @file{src/Makefile}, and @file{config.h}
1569 being created at the end after @command{configure} has probed the
1570 system. It is now possible to run all the targets we wish
1571 (@pxref{Standard Targets}). For instance:
1574 ~/amhello % @kbd{make}
1576 ~/amhello % @kbd{src/hello}
1578 This is amhello 1.0.
1579 ~/amhello % @kbd{make distcheck}
1581 =============================================
1582 amhello-1.0 archives ready for distribution:
1584 =============================================
1587 Running @command{autoreconf} is only needed initially, when
1588 the GNU Build System does not exist. When you later change some
1589 instructions in a @file{Makefile.am} or @file{configure.ac}, the
1590 relevant part of the build system will be regenerated automatically
1591 when you execute @command{make}.
1593 @command{autoreconf} is a script that calls @command{autoconf},
1594 @command{automake}, and related commands in the right order. If you
1595 are beginning with these tools, it is not important to figure out in
1596 which order all of these tools should be invoked and why. (But for the
1597 curious: the basic idea is to run:
1600 @item @command{aclocal} (@pxref{aclocal Invocation}),
1601 @item @command{autoconf} (@pxref{,,,autoconf, The Autoconf Manual}),
1602 @item (if needed) @command{autoheader} (part of the
1603 Autoconf distribution), and
1604 @item @command{automake} (@pxref{automake Invocation}).
1608 If needed, tools related to Gettext (@pxref{,,,gettext, GNU gettext
1609 utilities}) and Libtool (@pxref{,,,libtool, GNU libtool}) are also
1610 invoked at different points. Thus, as you can see, using
1611 @command{autoreconf} is quite a bit more convenient.
1613 Nevertheless, because Autoconf and Automake have separate manuals, an
1614 essential idea to understand is that Autoconf is in charge of creating
1615 @file{configure} from @file{configure.ac}, while Automake is in charge
1616 of creating @file{Makefile.in}s from @file{Makefile.am}s and
1617 @file{configure.ac}. This should at least direct you to the right
1618 manual when seeking answers.
1620 @node amhello's configure.ac Setup Explained
1621 @subsection @code{amhello}'s @file{configure.ac} Setup Explained
1623 @cindex @file{configure.ac}, Hello World
1625 Let us begin with the contents of @file{configure.ac}.
1628 AC_INIT([amhello], [1.0], [@value{PACKAGE_BUGREPORT}])
1629 AM_INIT_AUTOMAKE([-Wall -Werror foreign])
1631 AC_CONFIG_HEADERS([config.h])
1639 This file is read by both @command{autoconf} (to create
1640 @file{configure}) and @command{automake} (to create the various
1641 @file{Makefile.in}s). It contains a series of M4 macros that will be
1642 expanded as shell code to finally form the @file{configure} script.
1643 We will not elaborate on the syntax of this file, because the Autoconf
1644 manual has a whole section about it (@pxref{Writing Autoconf Input, ,
1645 Writing @file{configure.ac}, autoconf, The Autoconf Manual}).
1647 The macros prefixed with @code{AC_} are Autoconf macros, documented
1648 in the Autoconf manual (@pxref{Autoconf Macro Index, , Autoconf Macro
1649 Index, autoconf, The Autoconf Manual}). The macros that start with
1650 @code{AM_} are Automake macros, documented later in this manual
1651 (@pxref{Macro Index}).
1653 The first two lines of @file{configure.ac} initialize Autoconf and
1654 Automake. @code{AC_INIT} takes in as parameters the name of the package,
1655 its version number, and a contact address for bug-reports about the
1656 package (this address is output at the end of @code{./configure
1657 --help}, for instance). When adapting this setup to your own package,
1658 by all means please do not blindly copy Automake's address: use the
1659 mailing list of your package, or your own mail address.
1665 The argument to @code{AM_INIT_AUTOMAKE} is a list of options for
1666 @command{automake} (@pxref{Options}). @option{-Wall} and
1667 @option{-Werror} ask @command{automake} to turn on all warnings and
1668 report them as errors. We are speaking of @strong{Automake} warnings
1669 here, such as dubious instructions in @file{Makefile.am}. This has
1670 absolutely nothing to do with how the compiler will be called, even
1671 though it may support options with similar names. Using @option{-Wall
1672 -Werror} is a safe setting when starting to work on a package: you do
1673 not want to miss any issues. Later you may decide to relax things a
1674 bit. The @option{foreign} option tells Automake that this package
1675 will not follow the GNU Standards. GNU packages should always
1676 distribute additional files such as @file{ChangeLog}, @file{AUTHORS},
1677 etc. We do not want @command{automake} to complain about these
1678 missing files in our small example.
1680 The @code{AC_PROG_CC} line causes the @command{configure} script to
1681 search for a C compiler and define the variable @code{CC} with its
1682 name. The @file{src/Makefile.in} file generated by Automake uses the
1683 variable @code{CC} to build @file{hello}, so when @command{configure}
1684 creates @file{src/Makefile} from @file{src/Makefile.in}, it will define
1685 @code{CC} with the value it has found. If Automake is asked to create
1686 a @file{Makefile.in} that uses @code{CC} but @file{configure.ac} does
1687 not define it, it will suggest you add a call to @code{AC_PROG_CC}.
1689 The @code{AC_CONFIG_HEADERS([config.h])} invocation causes the
1690 @command{configure} script to create a @file{config.h} file gathering
1691 @samp{#define}s defined by other macros in @file{configure.ac}. In our
1692 case, the @code{AC_INIT} macro already defined a few of them. Here
1693 is an excerpt of @file{config.h} after @command{configure} has run:
1697 /* Define to the address where bug reports for this package should be sent. */
1698 #define PACKAGE_BUGREPORT "@value{PACKAGE_BUGREPORT}"
1700 /* Define to the full name and version of this package. */
1701 #define PACKAGE_STRING "amhello 1.0"
1705 As you probably noticed, @file{src/main.c} includes @file{config.h} so
1706 it can use @code{PACKAGE_STRING}. In a real-world project,
1707 @file{config.h} can grow quite large, with one @samp{#define} per
1708 feature probed on the system.
1710 The @code{AC_CONFIG_FILES} macro declares the list of files that
1711 @command{configure} should create from their @file{*.in} templates.
1712 Automake also scans this list to find the @file{Makefile.am} files it must
1713 process. (This is important to remember: when adding a new directory
1714 to your project, you should add its @file{Makefile} to this list,
1715 otherwise Automake will never process the new @file{Makefile.am} you
1716 wrote in that directory.)
1718 Finally, the @code{AC_OUTPUT} line is a closing command that actually
1719 produces the part of the script in charge of creating the files
1720 registered with @code{AC_CONFIG_HEADERS} and @code{AC_CONFIG_FILES}.
1722 @cindex @command{autoscan}
1724 When starting a new project, we suggest you start with such a simple
1725 @file{configure.ac}, and gradually add the other tests it requires.
1726 The command @command{autoscan} can also suggest a few of the tests
1727 your package may need (@pxref{autoscan Invocation, , Using
1728 @command{autoscan} to Create @file{configure.ac}, autoconf, The
1732 @node amhello's Makefile.am Setup Explained
1733 @subsection @code{amhello}'s @file{Makefile.am} Setup Explained
1735 @cindex @file{Makefile.am}, Hello World
1737 We now turn to @file{src/Makefile.am}. This file contains
1738 Automake instructions to build and install @file{hello}.
1741 bin_PROGRAMS = hello
1742 hello_SOURCES = main.c
1745 A @file{Makefile.am} has the same syntax as an ordinary
1746 @file{Makefile}. When @command{automake} processes a
1747 @file{Makefile.am} it copies the entire file into the output
1748 @file{Makefile.in} (that will be later turned into @file{Makefile} by
1749 @command{configure}) but will react to certain variable definitions
1750 by generating some build rules and other variables.
1751 Often @file{Makefile.am}s contain only a list of variable definitions as
1752 above, but they can also contain other variable and rule definitions that
1753 @command{automake} will pass along without interpretation.
1755 Variables that end with @code{_PROGRAMS} are special variables
1756 that list programs that the resulting @file{Makefile} should build.
1757 In Automake speak, this @code{_PROGRAMS} suffix is called a
1758 @dfn{primary}; Automake recognizes other primaries such as
1759 @code{_SCRIPTS}, @code{_DATA}, @code{_LIBRARIES}, etc.@: corresponding
1760 to different types of files.
1762 The @samp{bin} part of the @code{bin_PROGRAMS} tells
1763 @command{automake} that the resulting programs should be installed in
1764 @var{bindir}. Recall that the GNU Build System uses a set of variables
1765 to denote destination directories and allow users to customize these
1766 locations (@pxref{Standard Directory Variables}). Any such directory
1767 variable can be put in front of a primary (omitting the @code{dir}
1768 suffix) to tell @command{automake} where to install the listed files.
1770 Programs need to be built from source files, so for each program
1771 @code{@var{prog}} listed in a @code{@w{_PROGRAMS}} variable,
1772 @command{automake} will look for another variable named
1773 @code{@var{prog}_SOURCES} listing its source files. There may be more
1774 than one source file: they will all be compiled and linked together.
1776 Automake also knows that source files need to be distributed when
1777 creating a tarball (unlike built programs). So a side-effect of this
1778 @code{hello_SOURCES} declaration is that @file{main.c} will be
1779 part of the tarball created by @code{make dist}.
1781 Finally here are some explanations regarding the top-level
1786 dist_doc_DATA = README
1789 @code{SUBDIRS} is a special variable listing all directories that
1790 @command{make} should recurse into before processing the current
1791 directory. So this line is responsible for @command{make} building
1792 @file{src/hello} even though we run it from the top-level. This line
1793 also causes @code{make install} to install @file{src/hello} before
1794 installing @file{README} (not that this order matters).
1796 The line @code{dist_doc_DATA = README} causes @file{README} to be
1797 distributed and installed in @var{docdir}. Files listed with the
1798 @code{_DATA} primary are not automatically part of the tarball built
1799 with @code{make dist}, so we add the @code{dist_} prefix so they get
1800 distributed. However, for @file{README} it would not have been
1801 necessary: @command{automake} automatically distributes any
1802 @file{README} file it encounters (the list of other files
1803 automatically distributed is presented by @code{automake --help}).
1804 The only important effect of this second line is therefore to install
1805 @file{README} during @code{make install}.
1807 One thing not covered in this example is accessing the installation
1808 directory values (@pxref{Standard Directory Variables}) from your
1809 program code, that is, converting them into defined macros. For this,
1810 @pxref{Defining Directories,,, autoconf, The Autoconf Manual}.
1814 @chapter General ideas
1816 The following sections cover a few basic ideas that will help you
1817 understand how Automake works.
1820 * General Operation:: General operation of Automake
1821 * Strictness:: Standards conformance checking
1822 * Uniform:: The Uniform Naming Scheme
1823 * Length Limitations:: Staying below the command line length limit
1824 * Canonicalization:: How derived variables are named
1825 * User Variables:: Variables reserved for the user
1826 * Auxiliary Programs:: Programs automake might require
1830 @node General Operation
1831 @section General Operation
1833 Automake works by reading a @file{Makefile.am} and generating a
1834 @file{Makefile.in}. Certain variables and rules defined in the
1835 @file{Makefile.am} instruct Automake to generate more specialized code;
1836 for instance, a @code{bin_PROGRAMS} variable definition will cause rules
1837 for compiling and linking programs to be generated.
1839 @cindex Non-standard targets
1840 @cindex @code{git-dist}, non-standard example
1843 The variable definitions and rules in the @file{Makefile.am} are
1844 copied mostly verbatim into the generated file, with all variable
1845 definitions preceding all rules. This allows you to add almost
1846 arbitrary code into the generated @file{Makefile.in}. For instance,
1847 the Automake distribution includes a non-standard rule for the
1848 @code{git-dist} target, which the Automake maintainer uses to make
1849 distributions from the source control system.
1851 @cindex GNU Make extensions
1853 Note that most GNU Make extensions are not recognized by Automake. Using
1854 such extensions in a @file{Makefile.am} will lead to errors or confusing
1857 @cindex Append operator
1859 A special exception is that the GNU Make append operator, @samp{+=}, is
1860 supported. This operator appends its right hand argument to the variable
1861 specified on the left. Automake will translate the operator into
1862 an ordinary @samp{=} operator; @samp{+=} will thus work with any make program.
1864 Automake tries to keep comments grouped with any adjoining rules or
1865 variable definitions.
1867 @cindex Limitations of automake parser
1868 @cindex Automake parser, limitations of
1869 @cindex indentation in Makefile.am
1870 Generally, Automake is not particularly smart in the parsing of unusual
1871 @file{Makefile} constructs, so you're advised to avoid fancy constructs or
1872 ``creative'' use of whitespace.
1873 @c Keep this in sync with doc-parsing-buglets-tabs.sh
1874 For example, @key{TAB} characters cannot be used between a target name
1875 and the following ``@code{:}'' character, and variable assignments
1876 shouldn't be indented with @key{TAB} characters.
1877 @c Keep this in sync with doc-parsing-buglets-colneq-subst.sh
1878 Also, using more complex macros in target names can cause trouble:
1881 % @kbd{cat Makefile.am}
1884 Makefile.am:1: bad characters in variable name '$(FOO'
1885 Makefile.am:1: ':='-style assignments are not portable
1888 @cindex Make targets, overriding
1889 @cindex Make rules, overriding
1890 @cindex Overriding make rules
1891 @cindex Overriding make targets
1893 A rule defined in @file{Makefile.am} generally overrides any such
1894 rule of a similar name that would be automatically generated by
1895 @command{automake}. Although this is a supported feature, it is generally
1896 best to avoid making use of it, as sometimes the generated rules are
1899 @cindex Variables, overriding
1900 @cindex Overriding make variables
1902 Similarly, a variable defined in @file{Makefile.am} or
1903 @code{AC_SUBST}ed from @file{configure.ac} will override any
1904 definition of the variable that @command{automake} would ordinarily
1905 create. This feature is often more useful than the ability to
1906 override a rule. Be warned that many of the variables generated by
1907 @command{automake} are considered to be for internal use only, and their
1908 names might change in future releases.
1910 @cindex Recursive operation of Automake
1911 @cindex Automake, recursive operation
1912 @cindex Example of recursive operation
1914 When examining a variable definition, Automake will recursively examine
1915 variables referenced in the definition. For example, if Automake is
1916 looking at the content of @code{foo_SOURCES} in this snippet
1918 @c Keep in sync with interp.sh
1921 foo_SOURCES = c.c $(xs)
1924 it would use the files @file{a.c}, @file{b.c}, and @file{c.c} as the
1925 contents of @code{foo_SOURCES}.
1927 @cindex @code{##} (special Automake comment)
1928 @cindex Special Automake comment
1929 @cindex Comment, special to Automake
1931 Automake also allows a form of comment that is @emph{not} copied into
1932 the output; all lines beginning with @samp{##} (leading spaces allowed)
1933 are completely ignored by Automake.
1935 It is customary to make the first line of @file{Makefile.am} read:
1937 @cindex Makefile.am, first line
1938 @cindex First line of Makefile.am
1941 ## Process this file with automake to produce Makefile.in
1944 @c FIXME document customary ordering of Makefile.am here!
1949 @c "Gnits" used to be a separate section.
1950 @c This @anchor allows old links to still work.
1952 @cindex Non-GNU packages
1954 While Automake is intended to be used by maintainers of GNU packages, it
1955 does make some effort to accommodate those who wish to use it, but do
1956 not want to use all the GNU conventions.
1958 @cindex Strictness, defined
1959 To this end, Automake supports three levels of @dfn{strictness}---how
1960 stringently Automake should enforce conformance with GNU conventions.
1961 Each strictness level can be selected using an option of the same name;
1964 The strictness levels are:
1968 @cindex Strictness, @option{gnu}
1969 @cindex @option{gnu} strictness
1971 This is the default level of strictness. Automake will check for
1972 basic compliance with the GNU standards for software packaging.
1973 @xref{Top,,, standards, The GNU Coding Standards}, for full details
1974 of these standards. Currently the following checks are made:
1978 The files @file{INSTALL}, @file{NEWS}, @file{README}, @file{AUTHORS},
1979 and @file{ChangeLog}, plus one of @file{COPYING.LIB}, @file{COPYING.LESSER}
1980 or @file{COPYING}, are required at the topmost directory of the package.
1982 If the @option{--add-missing} option is given, @command{automake} will
1983 add a generic version of the @file{INSTALL} file as well as the
1984 @file{COPYING} file containing the text of the current version of the
1985 GNU General Public License existing at the time of this Automake release
1986 (version 3 as this is written,
1987 @uref{https://www.gnu.org/@/copyleft/@/gpl.html}).
1988 However, an existing @file{COPYING} file will never be overwritten by
1992 The options @option{no-installman} and @option{no-installinfo} are
1996 Future versions of Automake will add more checks at this level of
1997 strictness; it is advisable to be familiar with the precise requirements
1998 of the GNU standards.
2000 Future versions of Automake may, at this level of strictness, require
2001 certain non-standard GNU tools to be available to maintainer-only
2002 @file{Makefile} rules. For instance, in the future @command{pathchk}
2003 (@pxref{pathchk invocation,,, coreutils, GNU Coreutils})
2004 may be required to run @samp{make dist}.
2007 @cindex Strictness, @option{foreign}
2008 @cindex @option{foreign} strictness
2010 Automake will check for only those things that are absolutely
2011 required for proper operation. For instance, whereas GNU standards
2012 dictate the existence of a @file{NEWS} file, it will not be required in
2013 this mode. This strictness will also turn off some warnings by default
2014 (among them, portability warnings).
2017 @cindex Strictness, @option{gnits}
2018 @cindex @option{gnits} strictness
2020 Automake will check for compliance to the as-yet-unwritten @dfn{Gnits
2021 standards}. These are based on the GNU standards, but are even more
2022 detailed. Unless you are a Gnits standards contributor, it is
2023 recommended that you avoid this option until such time as the Gnits
2024 standard is published (which is unlikely to ever happen).
2026 Currently, @option{--gnits} does all the checks that
2027 @option{--gnu} does, and checks the following as well:
2031 @samp{make installcheck} will check to make sure that the
2032 @option{--help} and @option{--version} print a usage message and a
2033 version string, respectively. This is the @option{std-options} option
2037 @samp{make dist} will check to make sure the @file{NEWS} file has been
2038 updated to the current version.
2041 @code{VERSION} is checked to make sure its format complies with Gnits
2043 @c FIXME xref when standards are finished
2046 @cindex @file{README-alpha}
2047 If @code{VERSION} indicates that this is an alpha release, and the file
2048 @file{README-alpha} appears in the topmost directory of a package, then
2049 it is included in the distribution. This is done in @option{--gnits}
2050 mode, and no other, because this mode is the only one where version
2051 number formats are constrained, and hence the only mode where Automake
2052 can automatically determine whether @file{README-alpha} should be
2056 The file @file{THANKS} is required.
2064 @section The Uniform Naming Scheme
2066 @cindex Uniform naming scheme
2068 Automake variables generally follow a @dfn{uniform naming scheme} that
2069 makes it easy to decide how programs (and other derived objects) are
2070 built, and how they are installed. This scheme also supports
2071 @command{configure} time determination of what should be built.
2073 @cindex @code{_PROGRAMS} primary variable
2074 @cindex @code{PROGRAMS} primary variable
2075 @cindex Primary variable, @code{PROGRAMS}
2076 @cindex Primary variable, defined
2079 At @command{make} time, certain variables are used to determine which
2080 objects are to be built. The variable names are made of several pieces
2081 that are concatenated together.
2083 The piece that tells @command{automake} what is being built is commonly called
2084 the @dfn{primary}. For instance, the primary @code{PROGRAMS} holds a
2085 list of programs that are to be compiled and linked.
2088 @cindex @code{pkgdatadir}, defined
2089 @cindex @code{pkgincludedir}, defined
2090 @cindex @code{pkglibdir}, defined
2091 @cindex @code{pkglibexecdir}, defined
2094 @vindex pkgincludedir
2096 @vindex pkglibexecdir
2098 @cindex @code{PACKAGE}, directory
2099 A different set of names is used to decide where the built objects
2100 should be installed. These names are prefixes to the primary, and they
2101 indicate which standard directory should be used as the installation
2102 directory. The standard directory names are given in the GNU standards
2103 (@pxref{Directory Variables, , , standards, The GNU Coding Standards}).
2104 Automake extends this list with @code{pkgdatadir}, @code{pkgincludedir},
2105 @code{pkglibdir}, and @code{pkglibexecdir}; these are the same as the
2106 non-@samp{pkg} versions, but with @samp{$(PACKAGE)} appended. For instance,
2107 @code{pkglibdir} is defined as @samp{$(libdir)/$(PACKAGE)}.
2109 @cindex @code{EXTRA_}, prepending
2110 For each primary, there is one additional variable named by prepending
2111 @samp{EXTRA_} to the primary name. This variable is used to list
2112 objects that may or may not be built, depending on what
2113 @command{configure} decides. This variable is required because Automake
2114 must statically know the entire list of objects that may be built in
2115 order to generate a @file{Makefile.in} that will work in all cases.
2117 @cindex @code{EXTRA_PROGRAMS}, defined
2118 @cindex Example, @code{EXTRA_PROGRAMS}
2119 @cindex @command{cpio} example
2121 For instance, @command{cpio} decides at configure time which programs
2122 should be built. Some of the programs are installed in @code{bindir},
2123 and some are installed in @code{sbindir}:
2126 EXTRA_PROGRAMS = mt rmt
2127 bin_PROGRAMS = cpio pax
2128 sbin_PROGRAMS = $(MORE_PROGRAMS)
2131 Defining a primary without a prefix as a variable, e.g.,
2132 @samp{PROGRAMS}, is an error.
2134 Note that the common @samp{dir} suffix is left off when constructing the
2135 variable names; thus one writes @samp{bin_PROGRAMS} and not
2136 @samp{bindir_PROGRAMS}.
2138 Not every sort of object can be installed in every directory.
2139 Automake will flag those attempts it finds in error (but see below how
2140 to override the check if you need to). Automake will also diagnose
2141 obvious misspellings in directory names.
2143 @cindex Extending list of installation directories
2144 @cindex Installation directories, extending list
2146 Sometimes the standard directories---even as augmented by
2147 Automake---are not enough. In particular it is sometimes useful, for
2148 clarity, to install objects in a subdirectory of some predefined
2149 directory. To this end, Automake allows you to extend the list of
2150 possible installation directories. A given prefix (e.g., @samp{zar})
2151 is valid if a variable of the same name with @samp{dir} appended is
2152 defined (e.g., @samp{zardir}).
2154 For instance, the following snippet will install @file{file.xml} into
2155 @samp{$(datadir)/xml}.
2157 @c Keep in sync with primary-prefix-couples-documented-valid.sh
2159 xmldir = $(datadir)/xml
2163 This feature can also be used to override the sanity checks Automake
2164 performs to diagnose suspicious directory/primary couples (in the
2165 unlikely case that you need to omit these checks). For example,
2166 Automake would error out on this input:
2168 @c Should be tested in primary-prefix-invalid-couples.sh
2170 # Forbidden directory combinations, automake will error out on this.
2171 pkglib_PROGRAMS = foo
2172 doc_LIBRARIES = libquux.a
2176 but it will succeed with this:
2178 @c Keep in sync with primary-prefix-couples-documented-valid.sh
2180 # Work around forbidden directory combinations. Do not use this
2181 # without a very good reason!
2182 my_execbindir = $(pkglibdir)
2183 my_doclibdir = $(docdir)
2184 my_execbin_PROGRAMS = foo
2185 my_doclib_LIBRARIES = libquux.a
2188 The @samp{exec} substring of the @samp{my_execbindir} variable lets
2189 the files be installed at the right time (@pxref{The Two Parts of
2192 @cindex @samp{noinst_} primary prefix, definition
2195 The special prefix @samp{noinst_} indicates that the objects in question
2196 should be built but not installed at all. This is usually used for
2197 objects required to build the rest of your package, for instance static
2198 libraries (@pxref{A Library}), or helper scripts.
2200 @cindex @samp{check_} primary prefix, definition
2203 The special prefix @samp{check_} indicates that the objects in question
2204 should not be built until the @samp{make check} command is run. Those
2205 objects are not installed either.
2207 The current primary names are @samp{PROGRAMS}, @samp{LIBRARIES},
2208 @samp{LTLIBRARIES}, @samp{LISP}, @samp{PYTHON}, @samp{JAVA},
2209 @samp{SCRIPTS}, @samp{DATA}, @samp{HEADERS}, @samp{MANS}, and
2223 Some primaries also allow additional prefixes that control other
2224 aspects of @command{automake}'s behavior. The currently defined prefixes
2225 are @samp{dist_}, @samp{nodist_}, @samp{nobase_}, and @samp{notrans_}.
2226 These prefixes are explained later (@pxref{Program and Library Variables})
2227 (@pxref{Man Pages}).
2230 @node Length Limitations
2231 @section Staying below the command line length limit
2233 @cindex command line length limit
2236 Traditionally, most unix-like systems have a length limitation for the
2237 command line arguments and environment contents when creating new
2238 processes (see for example
2239 @uref{https://www.in-ulm.de/@/~mascheck/@/various/@/argmax/} for an
2240 overview on this issue),
2241 which of course also applies to commands spawned by @command{make}.
2242 POSIX requires this limit to be at least 4096 bytes, and most modern
2243 systems have quite high limits (or are unlimited).
2245 In order to create portable Makefiles that do not trip over these
2246 limits, it is necessary to keep the length of file lists bounded.
2247 Unfortunately, it is not possible to do so fully transparently within
2248 Automake, so your help may be needed. Typically, you can split long
2249 file lists manually and use different installation directory names for
2250 each list. For example,
2253 data_DATA = file1 @dots{} file@var{N} file@var{N+1} @dots{} file@var{2N}
2257 may also be written as
2259 @c Keep in sync with primary-prefix-couples-documented-valid.sh
2261 data_DATA = file1 @dots{} file@var{N}
2262 data2dir = $(datadir)
2263 data2_DATA = file@var{N+1} @dots{} file@var{2N}
2267 and will cause Automake to treat the two lists separately during
2268 @code{make install}. See @ref{The Two Parts of Install} for choosing
2269 directory names that will keep the ordering of the two parts of
2270 installation Note that @code{make dist} may still only work on a host
2271 with a higher length limit in this example.
2273 Automake itself employs a couple of strategies to avoid long command
2274 lines. For example, when @samp{$@{srcdir@}/} is prepended to file
2275 names, as can happen with above @code{$(data_DATA)} lists, it limits
2276 the amount of arguments passed to external commands.
2278 Unfortunately, some systems' @command{make} commands may prepend
2279 @code{VPATH} prefixes like @samp{$@{srcdir@}/} to file names from the
2280 source tree automatically (@pxref{Automatic Rule Rewriting, , Automatic
2281 Rule Rewriting, autoconf, The Autoconf Manual}). In this case, the user
2282 may have to switch to use GNU Make, or refrain from using VPATH builds,
2283 in order to stay below the length limit.
2285 For libraries and programs built from many sources, convenience archives
2286 may be used as intermediates in order to limit the object list length
2287 (@pxref{Libtool Convenience Libraries}).
2290 @node Canonicalization
2291 @section How derived variables are named
2293 @cindex canonicalizing Automake variables
2295 Sometimes a Makefile variable name is derived from some text the
2296 maintainer supplies. For instance, a program name listed in
2297 @samp{_PROGRAMS} is rewritten into the name of a @samp{_SOURCES}
2298 variable. In cases like this, Automake canonicalizes the text, so that
2299 program names and the like do not have to follow Makefile variable naming
2300 rules. All characters in the name except for letters, numbers, the
2301 strudel (@@), and the underscore are turned into underscores when making
2302 variable references.
2304 For example, if your program is named @file{sniff-glue}, the derived
2305 variable name would be @samp{sniff_glue_SOURCES}, not
2306 @samp{sniff-glue_SOURCES}. Similarly the sources for a library named
2307 @file{libmumble++.a} should be listed in the
2308 @samp{libmumble___a_SOURCES} variable.
2310 The strudel is an addition, to make the use of Autoconf substitutions in
2311 variable names less obfuscating.
2314 @node User Variables
2315 @section Variables reserved for the user
2317 @cindex variables, reserved for the user
2318 @cindex user variables
2320 Some @file{Makefile} variables are reserved by the GNU Coding Standards
2321 for the use of the ``user''---the person building the package. For
2322 instance, @code{CFLAGS} is one such variable.
2324 Sometimes package developers are tempted to set user variables such as
2325 @code{CFLAGS} because it appears to make their job easier. However,
2326 the package itself should never set a user variable, particularly not
2327 to include switches that are required for proper compilation of the
2328 package. Since these variables are documented as being for the
2329 package builder, that person rightfully expects to be able to override
2330 any of these variables at build time.
2332 To get around this problem, Automake introduces an automake-specific
2333 shadow variable for each user flag variable. (Shadow variables are
2334 not introduced for variables like @code{CC}, where they would make no
2335 sense.) The shadow variable is named by prepending @samp{AM_} to the
2336 user variable's name. For instance, the shadow variable for
2337 @code{YFLAGS} is @code{AM_YFLAGS}. The package maintainer---that is,
2338 the author(s) of the @file{Makefile.am} and @file{configure.ac}
2339 files---may adjust these shadow variables however necessary.
2341 @xref{Flag Variables Ordering}, for more discussion about these
2342 variables and how they interact with per-target variables.
2344 @node Auxiliary Programs
2345 @section Programs automake might require
2347 @cindex Programs, auxiliary
2348 @cindex Auxiliary programs
2350 Automake sometimes requires helper programs so that the generated
2351 @file{Makefile} can do its work properly. There are a fairly large
2352 number of them, and we list them here.
2354 Although all of these files are distributed and installed with
2355 Automake, a couple of them are maintained separately. The Automake
2356 copies are updated before each release, but we mention the original
2357 source in case you need more recent versions.
2362 This is a wrapper primarily for the Microsoft lib archiver, to make
2367 This is a wrapper for compilers that do not accept options @option{-c}
2368 and @option{-o} at the same time. It is only used when absolutely
2369 required. Such compilers are rare, with the Microsoft C/C++ Compiler
2370 as the most notable exception. This wrapper also makes the following
2371 common options available for that compiler, while performing file name
2372 translation where needed: @option{-I}, @option{-L}, @option{-l},
2373 @option{-Wl,} and @option{-Xlinker}.
2377 @cmindex config.guess
2379 These two programs compute the canonical triplets for the given build,
2380 host, or target architecture. These programs are updated regularly to
2381 support new architectures and fix probes broken by changes in new
2382 kernel versions. Each new release of Automake comes with up-to-date
2383 copies of these programs. If your copy of Automake is getting old,
2384 you are encouraged to fetch the latest versions of these files from
2385 @url{https://savannah.gnu.org/git/?group=config} before making a
2390 This program understands how to run a compiler so that it will
2391 generate not only the desired output but also dependency information
2392 that is then used by the automatic dependency tracking feature
2393 (@pxref{Dependencies}).
2397 This is a replacement for the @command{install} program that works on
2398 platforms where @command{install} is unavailable or unusable.
2402 This script is used to generate a @file{version.texi} file. It examines
2403 a file and prints some date information about it.
2406 @cmindex missing @r{program}
2407 This wraps a number of programs that are typically only required by
2408 maintainers. If the program in question doesn't exist, or seems too old,
2409 @command{missing} will print an informative warning before failing out,
2410 to provide the user with more context and information.
2413 @cmindex mkinstalldirs
2414 This script used to be a wrapper around @samp{mkdir -p}, which is not
2415 portable. Now we prefer to use @samp{install-sh -d} when @command{configure}
2416 finds that @samp{mkdir -p} does not work, this makes one less script to
2419 For backward compatibility @file{mkinstalldirs} is still used and
2420 distributed when @command{automake} finds it in a package. But it is no
2421 longer installed automatically, and it should be safe to remove it.
2425 This is used to byte-compile Python scripts.
2428 @cmindex test-driver
2429 This implements the default test driver offered by the parallel
2433 @cmindex texinfo.tex
2434 When Texinfo sources are in the package, this file is required for
2435 @samp{make dvi}, @samp{make ps} and @samp{make pdf}. The latest
2436 version can be downloaded from
2437 @url{https://www.gnu.org/software/texinfo/}. A working @TeX{}
2438 distribution, or at least a @file{tex} program, is also required.
2439 Furthermore, @samp{make dist} invokes @samp{make dvi}, so these become
2440 requirements for making a distribution with Texinfo sources.
2444 This program wraps @command{lex} and @command{yacc} to rename their
2445 output files. It also ensures that, for instance, multiple
2446 @command{yacc} instances can be invoked in a single directory in
2453 @chapter Some example packages
2455 This section contains two small examples.
2457 The first example (@pxref{Complete}) assumes you have an existing
2458 project already using Autoconf, with handcrafted @file{Makefile}s, and
2459 that you want to convert it to using Automake. If you are discovering
2460 both tools, it is probably better that you look at the Hello World
2461 example presented earlier (@pxref{Hello World}).
2463 The second example (@pxref{true}) shows how two programs can be built
2464 from the same file, using different compilation parameters. It
2465 contains some technical digressions that are probably best skipped on
2469 * Complete:: A simple example, start to finish
2470 * true:: Building true and false
2475 @section A simple example, start to finish
2477 @cindex Complete example
2479 Let's suppose you just finished writing @code{zardoz}, a program to make
2480 your head float from vortex to vortex. You've been using Autoconf to
2481 provide a portability framework, but your @file{Makefile.in}s have been
2482 ad-hoc. You want to make them bulletproof, so you turn to Automake.
2484 @cindex @code{AM_INIT_AUTOMAKE}, example use
2486 The first step is to update your @file{configure.ac} to include the
2487 commands that @command{automake} needs. The way to do this is to add an
2488 @code{AM_INIT_AUTOMAKE} call just after @code{AC_INIT}:
2491 AC_INIT([zardoz], [1.0])
2496 Since your program doesn't have any complicating factors (e.g., it
2497 doesn't use @code{gettext}, it doesn't want to build a shared library),
2498 you're done with this part. That was easy!
2500 @cindex @command{aclocal} program, introduction
2501 @cindex @file{aclocal.m4}, preexisting
2502 @cindex @file{acinclude.m4}, defined
2504 Now you must regenerate @file{configure}. But to do that, you'll need
2505 to tell @command{autoconf} how to find the new macro you've used. The
2506 easiest way to do this is to use the @command{aclocal} program to
2507 generate your @file{aclocal.m4} for you. But wait@dots{} maybe you
2508 already have an @file{aclocal.m4}, because you had to write some hairy
2509 macros for your program. The @command{aclocal} program lets you put
2510 your own macros into @file{acinclude.m4}, so simply rename and then
2514 mv aclocal.m4 acinclude.m4
2519 @cindex @command{zardoz} example
2521 Now it is time to write your @file{Makefile.am} for @code{zardoz}.
2522 Since @code{zardoz} is a user program, you want to install it where the
2523 rest of the user programs go: @code{bindir}. Additionally,
2524 @code{zardoz} has some Texinfo documentation. Your @file{configure.ac}
2525 script uses @code{AC_REPLACE_FUNCS}, so you need to link against
2526 @samp{$(LIBOBJS)}. So here's what you'd write:
2529 bin_PROGRAMS = zardoz
2530 zardoz_SOURCES = main.c head.c float.c vortex9.c gun.c
2531 zardoz_LDADD = $(LIBOBJS)
2533 info_TEXINFOS = zardoz.texi
2536 Now you can run @samp{automake --add-missing} to generate your
2537 @file{Makefile.in} and grab any auxiliary files you might need, and
2542 @section Building true and false
2544 @cindex Example, @command{false} and @command{true}
2545 @cindex @command{false} Example
2546 @cindex @command{true} Example
2548 Here is another, trickier example. It shows how to generate two
2549 programs (@code{true} and @code{false}) from the same source file
2550 (@file{true.c}). The difficult part is that each compilation of
2551 @file{true.c} requires different @code{cpp} flags.
2554 bin_PROGRAMS = true false
2556 false_LDADD = false.o
2559 $(COMPILE) -DEXIT_CODE=0 -c true.c
2562 $(COMPILE) -DEXIT_CODE=1 -o false.o -c true.c
2565 Note that there is no @code{true_SOURCES} definition. Automake will
2566 implicitly assume that there is a source file named @file{true.c}
2567 (@pxref{Default _SOURCES}), and
2568 define rules to compile @file{true.o} and link @file{true}. The
2569 @samp{true.o: true.c} rule supplied by the above @file{Makefile.am},
2570 will override the Automake generated rule to build @file{true.o}.
2572 @code{false_SOURCES} is defined to be empty---that way no implicit value
2573 is substituted. Because we have not listed the source of
2574 @file{false}, we have to tell Automake how to link the program. This is
2575 the purpose of the @code{false_LDADD} line. A @code{false_DEPENDENCIES}
2576 variable, holding the dependencies of the @file{false} target will be
2577 automatically generated by Automake from the content of
2580 The above rules won't work if your compiler doesn't accept both
2581 @option{-c} and @option{-o}. The simplest fix for this is to introduce a
2582 bogus dependency (to avoid problems with a parallel @command{make}):
2585 true.o: true.c false.o
2586 $(COMPILE) -DEXIT_CODE=0 -c true.c
2589 $(COMPILE) -DEXIT_CODE=1 -c true.c && mv true.o false.o
2592 As it turns out, there is also a much easier way to do this same task.
2593 Some of the above technique is useful enough that we've kept the
2594 example in the manual. However if you were to build @code{true} and
2595 @code{false} in real life, you would probably use per-program
2596 compilation flags, like so:
2598 @c Keep in sync with specflg7.sh and specflg8.sh
2600 bin_PROGRAMS = false true
2602 false_SOURCES = true.c
2603 false_CPPFLAGS = -DEXIT_CODE=1
2605 true_SOURCES = true.c
2606 true_CPPFLAGS = -DEXIT_CODE=0
2609 In this case Automake will cause @file{true.c} to be compiled twice,
2610 with different flags. In this instance, the names of the object files
2611 would be chosen by automake; they would be @file{false-true.o} and
2612 @file{true-true.o}. (The name of the object files rarely matters.)
2614 @node automake Invocation
2615 @chapter Creating a @file{Makefile.in}
2616 @c This node used to be named "Invoking automake". This @anchor
2617 @c allows old links to still work.
2618 @anchor{Invoking automake}
2620 @cindex Multiple @file{configure.ac} files
2621 @cindex Invoking @command{automake}
2622 @cindex @command{automake}, invoking
2623 @cindex Invocation of @command{automake}
2624 @cindex @command{automake}, invocation
2626 To create all the @file{Makefile.in}s for a package, run the
2627 @command{automake} program in the top level directory, with no
2628 arguments. @command{automake} will automatically find each
2629 appropriate @file{Makefile.am} (by scanning @file{configure.ac};
2630 @pxref{configure}) and generate the corresponding @file{Makefile.in}.
2631 Note that @command{automake} has a rather simplistic view of what
2632 constitutes a package; it assumes that a package has only one
2633 @file{configure.ac}, at the top. If your package has multiple
2634 @file{configure.ac}s, then you must run @command{automake} in each
2635 directory holding a @file{configure.ac}. (Alternatively, you may rely
2636 on Autoconf's @command{autoreconf}, which is able to recurse your
2637 package tree and run @command{automake} where appropriate.)
2639 You can optionally give @command{automake} an argument; @file{.am} is
2640 appended to the argument and the result is used as the name of the
2641 input file. This feature is generally only used to automatically
2642 rebuild an out-of-date @file{Makefile.in}. Note that
2643 @command{automake} must always be run from the topmost directory of a
2644 project, even if being used to regenerate the @file{Makefile.in} in
2645 some subdirectory. This is necessary because @command{automake} must
2646 scan @file{configure.ac}, and because @command{automake} uses the
2647 knowledge that a @file{Makefile.in} is in a subdirectory to change its
2648 behavior in some cases.
2651 Automake will run @command{autoconf} to scan @file{configure.ac} and
2652 its dependencies (i.e., @file{aclocal.m4} and any included file),
2653 therefore @command{autoconf} must be in your @env{PATH}. If there is
2654 an @env{AUTOCONF} variable in your environment it will be used
2655 instead of @command{autoconf}; this allows you to select a particular
2656 version of Autoconf. By the way, don't misunderstand this paragraph:
2657 @command{automake} runs @command{autoconf} to @strong{scan} your
2658 @file{configure.ac}; this won't build @file{configure} and you still
2659 have to run @command{autoconf} yourself for this purpose.
2661 @cindex @command{automake} options
2662 @cindex Options, @command{automake}
2663 @cindex Strictness, command line
2665 @command{automake} accepts the following options:
2667 @cindex Extra files distributed with Automake
2668 @cindex Files distributed with Automake
2669 @cindex @file{config.guess}
2673 @itemx --add-missing
2675 @opindex --add-missing
2676 Automake requires certain common files to exist in certain situations;
2677 for instance, @file{config.guess} is required if @file{configure.ac} invokes
2678 @code{AC_CANONICAL_HOST}. Automake is distributed with several of these
2679 files (@pxref{Auxiliary Programs}); this option will cause the missing
2680 ones to be automatically added to the package, whenever possible. In
2681 general if Automake tells you a file is missing, try using this option.
2682 By default Automake tries to make a symbolic link pointing to its own
2683 copy of the missing file; this can be changed with @option{--copy}.
2685 Many of the potentially-missing files are common scripts whose
2686 location may be specified via the @code{AC_CONFIG_AUX_DIR} macro.
2687 Therefore, @code{AC_CONFIG_AUX_DIR}'s setting affects whether a
2688 file is considered missing, and where the missing file is added
2691 In some strictness modes, additional files are installed, see @ref{Gnits}
2692 for more information.
2694 @item --libdir=@var{dir}
2696 Look for Automake data files in directory @var{dir} instead of in the
2697 installation directory. This is typically used for debugging.
2699 @vindex AUTOMAKE_LIBDIR
2700 The environment variable @env{AUTOMAKE_LIBDIR} provides another way to
2701 set the directory containing Automake data files. The
2702 @option{--libdir} option takes precedence over it.
2704 @item --print-libdir
2705 @opindex --print-libdir
2706 Print the path of the installation directory containing Automake-provided
2707 scripts and data files (e.g., @file{texinfo.texi} and
2714 When used with @option{--add-missing}, causes installed files to be
2715 copied. The default is to make a symbolic link.
2719 @itemx --force-missing
2720 @opindex --force-missing
2721 When used with @option{--add-missing}, causes standard files to be reinstalled
2722 even if they already exist in the source tree. This involves removing
2723 the file from the source tree before creating the new symlink (or, with
2724 @option{--copy}, copying the new file).
2728 Set the global strictness to @option{foreign}. For more information, see
2733 Set the global strictness to @option{gnits}. For more information, see
2738 Set the global strictness to @option{gnu}. For more information, see
2739 @ref{Strictness}. This is the default strictness.
2743 Print a summary of the command line options and exit.
2746 @itemx --ignore-deps
2748 This disables the dependency tracking feature in generated
2749 @file{Makefile}s; see @ref{Dependencies}.
2751 @item --include-deps
2752 @opindex --include-deps
2753 This enables the dependency tracking feature. This feature is enabled
2754 by default. This option is provided for historical reasons only and
2755 probably should not be used.
2759 Ordinarily @command{automake} creates all @file{Makefile.in}s mentioned in
2760 @file{configure.ac}. This option causes it to only update those
2761 @file{Makefile.in}s that are out of date with respect to one of their
2765 @itemx --output-dir=@var{dir}
2767 @opindex --output-dir
2768 Put the generated @file{Makefile.in} in the directory @var{dir}.
2769 Ordinarily each @file{Makefile.in} is created in the directory of the
2770 corresponding @file{Makefile.am}. This option is deprecated and will be
2771 removed in a future release.
2777 Cause Automake to print information about which files are being read or
2782 Print the version number of Automake and exit.
2784 @item -W @var{category}[,@var{category}...]
2785 @itemx --warnings=@var{category}[,@var{category}...]
2788 Output warnings about a @var{category} of potential problems with the
2789 package. @var{category} can be any of:
2793 Constructs compromising the ability to cross-compile the package.
2795 Minor deviations from the GNU Coding Standards
2796 (@pxref{Top, , , standards, The GNU Coding Standards}).
2798 Obsolete features or constructions.
2800 Redefinitions of Automake rules or variables.
2802 Portability issues (e.g., use of @command{make} features that are
2803 known to be not portable).
2804 @item portability-recursive
2805 Recursive, or nested, Make variable expansions (@code{$(foo$(x))}).
2806 These are not universally supported, but are more portable than the
2807 other non-portable constructs diagnosed by @option{-Wportability}.
2808 These warnings are turned on by @option{-Wportability} but can then be
2809 turned off specifically by @option{-Wno-portability-recursive}.
2810 @item extra-portability
2811 Extra portability issues, related to rarely-used tools such as
2812 the Microsoft @command{lib} archiver.
2814 Questionable syntax, unused variables, typos, etc.
2816 Unsupported or incomplete features.
2818 Turn on all the above categories of warnings.
2820 Turn off all the above categories of warnings.
2822 Treat warnings as errors.
2825 A category can be turned off by prefixing its name with @samp{no-}. For
2826 instance, @option{-Wno-syntax} will hide the warnings about unused
2829 Warnings in the @samp{gnu}, @samp{obsolete}, @samp{portability},
2830 @samp{syntax}, and @samp{unsupported} categories are turned on by
2831 default. The @samp{gnu} and @samp{portability} categories are turned
2832 off in @option{--foreign} strictness.
2834 @c Checked by extra-portability.sh
2835 Turning off @samp{portability} will also turn off @samp{extra-portability},
2836 and similarly turning on @samp{extra-portability} will also turn on
2837 @samp{portability}. However, turning on @samp{portability} or turning
2838 off @samp{extra-portability} will not affect the other category.
2840 Unknown warning categories supplied as an argument to @option{-W} will
2841 themselves produce a warning, in the @samp{unsupported} category. This
2842 warning is never treated as an error.
2845 The environment variable @env{WARNINGS} can contain a comma separated
2846 list of categories to enable. @option{-W} settings on the command line
2847 take precedence; for instance, @option{-Wnone} also turns off any
2848 warning categories enabled by @env{WARNINGS}.
2850 Unknown warning categories named in @env{WARNINGS} are silently ignored.
2854 @vindex AUTOMAKE_JOBS
2855 If the environment variable @env{AUTOMAKE_JOBS} contains a positive
2856 number, it is taken as the maximum number of Perl threads to use in
2857 @command{automake} for generating multiple @file{Makefile.in} files
2858 concurrently. This is an experimental feature.
2862 @chapter Scanning @file{configure.ac}, using @command{aclocal}
2864 @cindex @file{configure.ac}, scanning
2865 @cindex Scanning @file{configure.ac}
2866 @cindex Using @command{aclocal}
2867 @cindex @command{aclocal}, using
2869 Automake scans the package's @file{configure.ac} to determine certain
2870 information about the package. Some @command{autoconf} macros are required
2871 and some variables must be defined in @file{configure.ac}. Automake
2872 will also use information from @file{configure.ac} to further tailor its
2875 Automake also supplies some Autoconf macros to make the maintenance
2876 easier. These macros can automatically be put into your
2877 @file{aclocal.m4} using the @command{aclocal} program.
2880 * Requirements:: Configuration requirements
2881 * Optional:: Other things Automake recognizes
2882 * aclocal Invocation:: Auto-generating aclocal.m4
2883 * Macros:: Autoconf macros supplied with Automake
2888 @section Configuration requirements
2890 @cindex Automake requirements
2891 @cindex Requirements of Automake
2893 @acindex AM_INIT_AUTOMAKE
2894 The one real requirement of Automake is that your @file{configure.ac}
2895 call @code{AM_INIT_AUTOMAKE}. This macro does several things that are
2896 required for proper Automake operation (@pxref{Macros}).
2898 Here are the other macros that Automake requires but which are not run
2899 by @code{AM_INIT_AUTOMAKE}:
2902 @item AC_CONFIG_FILES
2904 @acindex AC_CONFIG_FILES
2906 These two macros are usually invoked as follows near the end of
2907 @file{configure.ac}.
2921 Automake uses these to determine which files to create (@pxref{Output, ,
2922 Creating Output Files, autoconf, The Autoconf Manual}). A listed file
2923 is considered to be an Automake generated @file{Makefile} if there
2924 exists a file with the same name and the @file{.am} extension appended.
2925 Typically, @samp{AC_CONFIG_FILES([foo/Makefile])} will cause Automake to
2926 generate @file{foo/Makefile.in} if @file{foo/Makefile.am} exists.
2928 When using @code{AC_CONFIG_FILES} with multiple input files, as in
2931 AC_CONFIG_FILES([Makefile:top.in:Makefile.in:bot.in])
2935 @command{automake} will generate the first @file{.in} input file for
2936 which a @file{.am} file exists. If no such file exists the output
2937 file is not considered to be generated by Automake.
2939 Files created by @code{AC_CONFIG_FILES}, be they Automake
2940 @file{Makefile}s or not, are all removed by @samp{make distclean}.
2941 Their inputs are automatically distributed, unless they
2942 are the output of prior @code{AC_CONFIG_FILES} commands.
2943 Finally, rebuild rules are generated in the Automake @file{Makefile}
2944 existing in the subdirectory of the output file, if there is one, or
2945 in the top-level @file{Makefile} otherwise.
2947 The above machinery (cleaning, distributing, and rebuilding) works
2948 fine if the @code{AC_CONFIG_FILES} specifications contain only
2949 literals. If part of the specification uses shell variables,
2950 @command{automake} will not be able to fulfill this setup, and you will
2951 have to complete the missing bits by hand. For instance, on
2953 @c Keep in sync with output11.sh
2957 AC_CONFIG_FILES([output:$file],, [file=$file])
2961 @command{automake} will output rules to clean @file{output}, and
2962 rebuild it. However the rebuild rule will not depend on @file{input},
2963 and this file will not be distributed either. (You must add
2964 @samp{EXTRA_DIST = input} to your @file{Makefile.am} if @file{input} is a
2969 @c Keep in sync with output11.sh
2974 AC_CONFIG_FILES([$file:input],, [file=$file])
2975 AC_CONFIG_FILES([$file2],, [file2=$file2])
2979 will only cause @file{input} to be distributed. No file will be
2980 cleaned automatically (add @samp{DISTCLEANFILES = output out}
2981 yourself), and no rebuild rule will be output.
2983 Obviously @command{automake} cannot guess what value @samp{$file} is
2984 going to hold later when @file{configure} is run, and it cannot use
2985 the shell variable @samp{$file} in a @file{Makefile}. However, if you
2986 make reference to @samp{$file} as @samp{$@{file@}} (i.e., in a way
2987 that is compatible with @command{make}'s syntax) and furthermore use
2988 @code{AC_SUBST} to ensure that @samp{$@{file@}} is meaningful in a
2989 @file{Makefile}, then @command{automake} will be able to use
2990 @samp{$@{file@}} to generate all of these rules. For instance, here is
2991 how the Automake package itself generates versioned scripts for its
2995 AC_SUBST([APIVERSION], @dots{})
2998 [tests/aclocal-$@{APIVERSION@}:tests/aclocal.in],
2999 [chmod +x tests/aclocal-$@{APIVERSION@}],
3000 [APIVERSION=$APIVERSION])
3002 [tests/automake-$@{APIVERSION@}:tests/automake.in],
3003 [chmod +x tests/automake-$@{APIVERSION@}])
3007 Here cleaning, distributing, and rebuilding are done automatically,
3008 because @samp{$@{APIVERSION@}} is known at @command{make}-time.
3010 Note that you should not use shell variables to declare
3011 @file{Makefile} files for which @command{automake} must create
3012 @file{Makefile.in}. Even @code{AC_SUBST} does not help here, because
3013 @command{automake} needs to know the file name when it runs in order
3014 to check whether @file{Makefile.am} exists. (In the very hairy case
3015 that your setup requires such use of variables, you will have to tell
3016 Automake which @file{Makefile.in}s to generate on the command-line.)
3018 It is possible to let @command{automake} emit conditional rules for
3019 @code{AC_CONFIG_FILES} with the help of @code{AM_COND_IF}
3025 Use literals for @file{Makefile}s, and for other files whenever possible.
3027 Use @samp{$file} (or @samp{$@{file@}} without @samp{AC_SUBST([file])})
3028 for files that @command{automake} should ignore.
3030 Use @samp{$@{file@}} and @samp{AC_SUBST([file])} for files
3031 that @command{automake} should not ignore.
3038 @section Other things Automake recognizes
3040 @cindex Macros Automake recognizes
3041 @cindex Recognized macros by Automake
3043 Every time Automake is run it calls Autoconf to trace
3044 @file{configure.ac}. This way it can recognize the use of certain
3045 macros and tailor the generated @file{Makefile.in} appropriately.
3046 Currently recognized macros and their effects are:
3049 @item AC_CANONICAL_BUILD
3050 @itemx AC_CANONICAL_HOST
3051 @itemx AC_CANONICAL_TARGET
3052 @vindex build_triplet
3053 @vindex host_triplet
3054 @vindex target_triplet
3055 Automake will ensure that @file{config.guess} and @file{config.sub}
3056 exist. Also, the @file{Makefile} variables @code{build_triplet},
3057 @code{host_triplet} and @code{target_triplet} are introduced. See
3058 @ref{Canonicalizing, , Getting the Canonical System Type, autoconf,
3059 The Autoconf Manual}.
3061 @item AC_CONFIG_AUX_DIR
3062 Automake will look for various helper scripts, such as
3063 @file{install-sh}, in the directory named in this macro invocation.
3064 @c This list is accurate relative to version 1.11
3065 (The full list of scripts is:
3067 @file{config.guess},
3075 @file{mkinstalldirs},
3080 Not all scripts are always searched for; some scripts
3081 will only be sought if the generated @file{Makefile.in} requires them.
3083 If @code{AC_CONFIG_AUX_DIR} is used, it must be given before the call
3084 to @code{AM_INIT_AUTOMAKE}; Automake will warn about this if it is not
3085 so. All other @code{AC_CONFIG_...} macros are conventionally called
3086 after @code{AM_INIT_AUTOMAKE}, though they may or may not work in
3087 other locations, with or without warnings.
3089 If @code{AC_CONFIG_AUX_DIR} is not given, the scripts are looked for in
3090 their standard locations. For @file{mdate-sh},
3091 @file{texinfo.tex}, and @file{ylwrap}, the standard location is the
3092 source directory corresponding to the current @file{Makefile.am}. For
3093 the rest, the standard location is the first one of @file{.}, @file{..},
3094 or @file{../..} (relative to the top source directory) that provides any
3095 one of the helper scripts. @xref{Input, , Finding `configure' Input,
3096 autoconf, The Autoconf Manual}.
3098 Required files from @code{AC_CONFIG_AUX_DIR} are automatically
3099 distributed, even if there is no @file{Makefile.am} in this directory.
3101 @item AC_CONFIG_LIBOBJ_DIR
3102 Automake will require the sources file declared with
3103 @code{AC_LIBSOURCE} (see below) in the directory specified by this
3106 @item AC_CONFIG_HEADERS
3107 Automake will generate rules to rebuild these headers from the
3108 corresponding templates (usually, the template for a @file{foo.h}
3109 header being @file{foo.h.in}).
3111 As with @code{AC_CONFIG_FILES} (@pxref{Requirements}), parts of the
3112 specification using shell variables will be ignored as far as
3113 cleaning, distributing, and rebuilding is concerned.
3115 Older versions of Automake required the use of
3116 @code{AM_CONFIG_HEADER}; this is no longer the case, and that macro
3117 has indeed been removed.
3119 @item AC_CONFIG_LINKS
3120 Automake will generate rules to remove @file{configure} generated
3121 links on @samp{make distclean} and to distribute named source files as
3122 part of @samp{make dist}.
3124 As with @code{AC_CONFIG_FILES} (@pxref{Requirements}), parts of the
3125 specification using shell variables will be ignored as far as cleaning
3126 and distributing is concerned. (There are no rebuild rules for links.)
3130 @itemx AC_LIBSOURCES
3132 Automake will automatically distribute any file listed in
3133 @code{AC_LIBSOURCE} or @code{AC_LIBSOURCES}.
3135 Note that the @code{AC_LIBOBJ} macro calls @code{AC_LIBSOURCE}. So if
3136 an Autoconf macro is documented to call @samp{AC_LIBOBJ([file])}, then
3137 @file{file.c} will be distributed automatically by Automake. This
3138 encompasses many macros like @code{AC_FUNC_ALLOCA},
3139 @code{AC_FUNC_MEMCMP}, @code{AC_REPLACE_FUNCS}, and others.
3141 By the way, direct assignments to @code{LIBOBJS} are no longer
3142 supported. You should always use @code{AC_LIBOBJ} for this purpose.
3143 @xref{AC_LIBOBJ vs LIBOBJS, , @code{AC_LIBOBJ} vs.@: @code{LIBOBJS},
3144 autoconf, The Autoconf Manual}.
3146 @item AC_PROG_RANLIB
3147 This is required if any libraries are built in the package.
3148 @xref{Particular Programs, , Particular Program Checks, autoconf, The
3152 This is required if any C++ source is included. @xref{Particular
3153 Programs, , Particular Program Checks, autoconf, The Autoconf Manual}.
3156 This is required if any Objective C source is included. @xref{Particular
3157 Programs, , Particular Program Checks, autoconf, The Autoconf Manual}.
3159 @item AC_PROG_OBJCXX
3160 This is required if any Objective C++ source is included. @xref{Particular
3161 Programs, , Particular Program Checks, autoconf, The Autoconf Manual}.
3164 This is required if any Fortran 77 source is included. @xref{Particular
3165 Programs, , Particular Program Checks, autoconf, The Autoconf Manual}.
3167 @item AC_F77_LIBRARY_LDFLAGS
3168 This is required for programs and shared libraries that are a mixture of
3169 languages that include Fortran 77 (@pxref{Mixing Fortran 77 With C and
3170 C++}). @xref{Macros, , Autoconf macros supplied with Automake}.
3173 Automake will add the flags computed by @code{AC_FC_SRCEXT} to compilation
3174 of files with the respective source extension (@pxref{Fortran Compiler, ,
3175 Fortran Compiler Characteristics, autoconf, The Autoconf Manual}).
3178 This is required if any Fortran 90/95 source is included. This macro is
3179 distributed with Autoconf version 2.58 and later. @xref{Particular
3180 Programs, , Particular Program Checks, autoconf, The Autoconf Manual}.
3182 @item AC_PROG_LIBTOOL
3184 Automake will turn on processing for @command{libtool} (@pxref{Top, ,
3185 Introduction, libtool, The Libtool Manual}).
3189 If a Yacc source file is seen, then you must either use this macro or
3190 define the variable @code{YACC} in @file{configure.ac}. The former is
3191 preferred (@pxref{Particular Programs, , Particular Program Checks,
3192 autoconf, The Autoconf Manual}).
3195 If a Lex source file is seen, then this macro must be used.
3196 @xref{Particular Programs, , Particular Program Checks, autoconf, The
3199 @item AC_REQUIRE_AUX_FILE
3200 For each @code{AC_REQUIRE_AUX_FILE([@var{file}])},
3201 @command{automake} will ensure that @file{@var{file}} exists in the
3202 aux directory, and will complain otherwise. It
3203 will also automatically distribute the file. This macro should be
3204 used by third-party Autoconf macros that require some supporting
3205 files in the aux directory specified with @code{AC_CONFIG_AUX_DIR}
3206 above. @xref{Input, , Finding @command{configure} Input, autoconf,
3207 The Autoconf Manual}.
3210 The first argument is automatically defined as a variable in each
3211 generated @file{Makefile.in}, unless @code{AM_SUBST_NOTMAKE} is also
3212 used for this variable. @xref{Setting Output Variables, , Setting
3213 Output Variables, autoconf, The Autoconf Manual}.
3215 For every substituted variable @var{var}, @command{automake} will add
3216 a line @code{@var{var} = @var{value}} to each @file{Makefile.in} file.
3217 Many Autoconf macros invoke @code{AC_SUBST} to set output variables
3218 this way, e.g., @code{AC_PATH_XTRA} defines @code{X_CFLAGS} and
3219 @code{X_LIBS}. Thus, you can access these variables as
3220 @code{$(X_CFLAGS)} and @code{$(X_LIBS)} in any @file{Makefile.am}
3221 if @code{AC_PATH_XTRA} is called.
3223 @item AM_CONDITIONAL
3224 This introduces an Automake conditional (@pxref{Conditionals}).
3227 This macro allows @code{automake} to detect subsequent access within
3228 @file{configure.ac} to a conditional previously introduced with
3229 @code{AM_CONDITIONAL}, thus enabling conditional @code{AC_CONFIG_FILES}
3230 (@pxref{Usage of Conditionals}).
3232 @item AM_GNU_GETTEXT
3233 This macro is required for packages that use GNU gettext
3234 (@pxref{gettext}). It is distributed with gettext. If Automake sees
3235 this macro it ensures that the package meets some of gettext's
3238 @item AM_GNU_GETTEXT_INTL_SUBDIR
3239 This macro specifies that the @file{intl/} subdirectory is to be built,
3240 even if the @code{AM_GNU_GETTEXT} macro was invoked with a first argument
3243 @item AM_MAINTAINER_MODE(@ovar{default-mode})
3244 @opindex --enable-maintainer-mode
3245 @opindex --disable-maintainer-mode
3246 This macro adds an @option{--enable-maintainer-mode} option to
3247 @command{configure}. If this is used, @command{automake} will cause
3248 ``maintainer-only'' rules to be turned off by default in the
3249 generated @file{Makefile.in}s, unless @var{default-mode} is
3250 @samp{enable}. This macro defines the @code{MAINTAINER_MODE}
3251 conditional, which you can use in your own @file{Makefile.am}.
3252 @xref{maintainer-mode}.
3254 @item AM_SUBST_NOTMAKE(@var{var})
3255 Prevent Automake from defining a variable @var{var}, even if it is
3256 substituted by @command{config.status}. Normally, Automake defines a
3257 @command{make} variable for each @command{configure} substitution,
3258 i.e., for each @code{AC_SUBST([@var{var}])}. This macro prevents that
3259 definition from Automake. If @code{AC_SUBST} has not been called
3260 for this variable, then @code{AM_SUBST_NOTMAKE} has no effects.
3261 Preventing variable definitions may be useful for substitution of
3262 multi-line values, where @code{@var{var} = @@@var{value}@@} might yield
3266 Files included by @file{configure.ac} using this macro will be
3267 detected by Automake and automatically distributed. They will also
3268 appear as dependencies in @file{Makefile} rules.
3270 @code{m4_include} is seldom used by @file{configure.ac} authors, but
3271 can appear in @file{aclocal.m4} when @command{aclocal} detects that
3272 some required macros come from files local to your package (as opposed to
3273 macros installed in a system-wide directory; @pxref{aclocal Invocation}).
3277 @node aclocal Invocation
3278 @section Auto-generating aclocal.m4
3279 @c This node used to be named "Invoking aclocal". This @anchor
3280 @c allows old links to still work.
3281 @anchor{Invoking aclocal}
3283 @cindex Invocation of @command{aclocal}
3284 @cindex @command{aclocal}, Invocation
3285 @cindex Invoking @command{aclocal}
3286 @cindex @command{aclocal}, Invoking
3288 Automake includes a number of Autoconf macros that can be used in your
3289 package (@pxref{Macros}); some of them are required by Automake in
3290 certain situations. These macros must be defined in your
3291 @file{aclocal.m4}; otherwise they will not be seen by
3294 The @command{aclocal} program will automatically generate
3295 @file{aclocal.m4} files based on the contents of @file{configure.ac}.
3296 This provides a convenient way to get Automake-provided macros,
3297 without having to search around. The @command{aclocal} mechanism
3298 allows other packages to supply their own macros (@pxref{Extending
3299 aclocal}). You can also use it to maintain your own set of custom
3300 macros (@pxref{Local Macros}).
3302 At startup, @command{aclocal} scans all the @file{.m4} files it can
3303 find, looking for macro definitions (@pxref{Macro Search Path}). Then
3304 it scans @file{configure.ac}. Any mention of one of the macros found
3305 in the first step causes that macro, and any macros it in turn
3306 requires, to be put into @file{aclocal.m4}.
3308 @emph{Putting} the file that contains the macro definition into
3309 @file{aclocal.m4} is usually done by copying the entire text of this
3310 file, including unused macro definitions as well as both @samp{#} and
3311 @samp{dnl} comments. If you want to make a comment that will be
3312 completely ignored by @command{aclocal}, use @samp{##} as the comment
3315 When a file selected by @command{aclocal} is located in a subdirectory
3316 specified as a relative search path with @command{aclocal}'s @option{-I}
3317 argument, @command{aclocal} assumes the file belongs to the package
3318 and uses @code{m4_include} instead of copying it into
3319 @file{aclocal.m4}. This makes the package smaller, eases dependency
3320 tracking, and cause the file to be distributed automatically.
3321 (@xref{Local Macros}, for an example.) Any macro that is found in a
3322 system-wide directory or via an absolute search path will be copied.
3323 So use @samp{-I `pwd`/reldir} instead of @samp{-I reldir} whenever
3324 some relative directory should be considered outside the package.
3326 The contents of @file{acinclude.m4}, if this file exists, are also
3327 automatically included in @file{aclocal.m4}. We recommend against
3328 using @file{acinclude.m4} in new packages (@pxref{Local Macros}).
3332 While computing @file{aclocal.m4}, @command{aclocal} runs
3333 @command{autom4te} (@pxref{Using autom4te, , Using @command{Autom4te},
3334 autoconf, The Autoconf Manual}) in order to trace the macros that are
3335 used, and omit from @file{aclocal.m4} all macros that are mentioned
3336 but otherwise unexpanded (this can happen when a macro is called
3337 conditionally). @command{autom4te} is expected to be in the
3338 @env{PATH}, just like @command{autoconf}. Its location can be
3339 overridden using the @env{AUTOM4TE} environment variable.
3341 Although this section explains the details of @command{aclocal}, in
3342 practice it is usually simpler to run @command{autoreconf}, instead of
3343 worrying about the required order of the various tools
3344 (@pxref{autoreconf Invocation, , Using @command{autoreconf},
3345 autoconf, The Autoconf Manual}).
3348 * aclocal Options:: Options supported by aclocal
3349 * Macro Search Path:: How aclocal finds .m4 files
3350 * Extending aclocal:: Writing your own aclocal macros
3351 * Local Macros:: Organizing local macros
3352 * Serials:: Serial lines in Autoconf macros
3353 * Future of aclocal:: aclocal's scheduled death
3356 @node aclocal Options
3357 @subsection aclocal Options
3359 @cindex @command{aclocal}, Options
3360 @cindex Options, @command{aclocal}
3362 @command{aclocal} accepts the following options:
3365 @item --automake-acdir=@var{dir}
3366 @opindex --automake-acdir
3367 Look for the automake-provided macro files in @var{dir} instead of
3368 in the installation directory. This is typically used for debugging.
3370 @vindex ACLOCAL_AUTOMAKE_DIR
3371 The environment variable @env{ACLOCAL_AUTOMAKE_DIR} provides another
3372 way to set the directory containing automake-provided macro files.
3373 However @option{--automake-acdir} takes precedence over it.
3375 @item --system-acdir=@var{dir}
3376 @opindex --system-acdir
3377 Look for the system-wide third-party macro files (and the special
3378 @file{dirlist} file) in @var{dir} instead of in the installation
3379 directory. This is typically used for debugging.
3381 @item --diff[=@var{command}]
3383 Run @var{command} on the M4 file that would be installed or overwritten
3384 by @option{--install}. The default @var{command} is @samp{diff -u}.
3385 This option implies @option{--install} and @option{--dry-run}.
3389 Do not overwrite (or create) @file{aclocal.m4} and M4 files installed
3390 by @option{--install}.
3394 Print a summary of the command line options and exit.
3398 Add the directory @var{dir} to the list of directories searched for
3403 Install system-wide third-party macros into the first directory
3404 specified with @samp{-I @var{dir}} instead of copying them in the
3406 @c Keep in sync with aclocal-install-absdir.sh
3407 Note that this will happen also if @var{dir} is an absolute path.
3409 @cindex serial number and @option{--install}
3410 When this option is used, and only when this option is used,
3411 @command{aclocal} will also honor @samp{#serial @var{number}} lines
3412 that appear in macros: an M4 file is ignored if there exists another
3413 M4 file with the same basename and a greater serial number in the
3414 search path (@pxref{Serials}).
3418 Always overwrite the output file. The default is to overwrite the
3419 output file only when needed, i.e., when its contents change or if one
3420 of its dependencies is younger.
3422 This option forces the update of @file{aclocal.m4} (or the file
3423 specified with @file{--output} below) and only this file, it has
3424 absolutely no influence on files that may need to be installed by
3427 @item --output=@var{file}
3429 Cause the output to be put into @var{file} instead of @file{aclocal.m4}.
3431 @item --print-ac-dir
3432 @opindex --print-ac-dir
3433 Prints the name of the directory that @command{aclocal} will search to
3434 find third-party @file{.m4} files. When this option is given, normal
3435 processing is suppressed. This option was used @emph{in the past} by
3436 third-party packages to determine where to install @file{.m4} macro
3437 files, but @emph{this usage is today discouraged}, since it causes
3438 @samp{$(prefix)} not to be thoroughly honored (which violates the
3439 GNU Coding Standards), and similar semantics can be better obtained
3440 with the @env{ACLOCAL_PATH} environment variable; @pxref{Extending aclocal}.
3444 Print the names of the files it examines.
3448 Print the version number of Automake and exit.
3451 @item --warnings=@var{category}
3454 Output warnings falling in @var{category}. @var{category} can be
3458 dubious syntactic constructs, underquoted macros, unused macros, etc.
3462 all the warnings, this is the default
3464 turn off all the warnings
3466 treat warnings as errors
3469 All warnings are output by default.
3472 The environment variable @env{WARNINGS} is honored in the same
3473 way as it is for @command{automake} (@pxref{automake Invocation}).
3477 @node Macro Search Path
3478 @subsection Macro Search Path
3480 @cindex Macro search path
3481 @cindex @command{aclocal} search path
3483 By default, @command{aclocal} searches for @file{.m4} files in the following
3484 directories, in this order:
3487 @item @var{acdir-APIVERSION}
3488 This is where the @file{.m4} macros distributed with Automake itself
3489 are stored. @var{APIVERSION} depends on the Automake release used;
3490 for example, for Automake 1.11.x, @var{APIVERSION} = @code{1.11}.
3493 This directory is intended for third party @file{.m4} files, and is
3494 configured when @command{automake} itself is built. This is
3495 @file{@@datadir@@/aclocal/}, which typically
3496 expands to @file{$@{prefix@}/share/aclocal/}. To find the compiled-in
3497 value of @var{acdir}, use the @option{--print-ac-dir} option
3498 (@pxref{aclocal Options}).
3501 As an example, suppose that @command{automake-1.11.2} was configured with
3502 @option{--prefix=@-/usr/local}. Then, the search path would be:
3505 @item @file{/usr/local/share/aclocal-1.11.2/}
3506 @item @file{/usr/local/share/aclocal/}
3509 The paths for the @var{acdir} and @var{acdir-APIVERSION} directories can
3510 be changed respectively through aclocal options @option{--system-acdir}
3511 and @option{--automake-acdir} (@pxref{aclocal Options}). Note however
3512 that these options are only intended for use by the internal Automake
3513 test suite, or for debugging under highly unusual situations; they are
3514 not ordinarily needed by end-users.
3516 As explained in (@pxref{aclocal Options}), there are several options that
3517 can be used to change or extend this search path.
3519 @subsubheading Modifying the Macro Search Path: @samp{-I @var{dir}}
3521 Any extra directories specified using @option{-I} options
3522 (@pxref{aclocal Options}) are @emph{prepended} to this search list. Thus,
3523 @samp{aclocal -I /foo -I /bar} results in the following search path:
3528 @item @var{acdir}-@var{APIVERSION}
3532 @subsubheading Modifying the Macro Search Path: @file{dirlist}
3533 @cindex @file{dirlist}
3535 There is a third mechanism for customizing the search path. If a
3536 @file{dirlist} file exists in @var{acdir}, then that file is assumed to
3537 contain a list of directory patterns, one per line. @command{aclocal}
3538 expands these patterns to directory names, and adds them to the search
3539 list @emph{after} all other directories. @file{dirlist} entries may
3540 use shell wildcards such as @samp{*}, @samp{?}, or @code{[...]}.
3542 For example, suppose
3543 @file{@var{acdir}/dirlist} contains the following:
3552 and that @command{aclocal} was called with the @samp{-I /foo -I /bar} options.
3553 Then, the search path would be
3555 @c @code looks better than @file here
3559 @item @var{acdir}-@var{APIVERSION}
3566 and all directories with path names starting with @code{/test3}.
3568 If the @option{--system-acdir=@var{dir}} option is used, then
3569 @command{aclocal} will search for the @file{dirlist} file in
3570 @var{dir}; but remember the warnings above against the use of
3571 @option{--system-acdir}.
3573 @file{dirlist} is useful in the following situation: suppose that
3574 @command{automake} version @code{1.11.2} is installed with
3575 @samp{--prefix=/usr} by the system vendor. Thus, the default search
3578 @c @code looks better than @file here
3580 @item @code{/usr/share/aclocal-1.11/}
3581 @item @code{/usr/share/aclocal/}
3584 However, suppose further that many packages have been manually
3585 installed on the system, with $prefix=/usr/local, as is typical. In
3586 that case, many of these ``extra'' @file{.m4} files are in
3587 @file{/usr/local/share/aclocal}. The only way to force
3588 @file{/usr/bin/aclocal} to find these ``extra'' @file{.m4} files is to
3589 always call @samp{aclocal -I /usr/local/share/aclocal}. This is
3590 inconvenient. With @file{dirlist}, one may create a file
3591 @file{/usr/share/aclocal/dirlist} containing only the single line
3594 /usr/local/share/aclocal
3597 Now, the ``default'' search path on the affected system is
3599 @c @code looks better than @file here
3601 @item @code{/usr/share/aclocal-1.11/}
3602 @item @code{/usr/share/aclocal/}
3603 @item @code{/usr/local/share/aclocal/}
3607 without the need for @option{-I} options; @option{-I} options can be reserved
3608 for project-specific needs (@file{my-source-dir/m4/}), rather than
3609 using them to work around local system-dependent tool installation
3612 Similarly, @file{dirlist} can be handy if you have installed a local
3613 copy of Automake in your account and want @command{aclocal} to look for
3614 macros installed at other places on the system.
3616 @anchor{ACLOCAL_PATH}
3617 @subsubheading Modifying the Macro Search Path: @file{ACLOCAL_PATH}
3618 @cindex @env{ACLOCAL_PATH}
3620 The fourth and last mechanism to customize the macro search path is
3621 also the simplest. Any directory included in the colon-separated
3622 environment variable @env{ACLOCAL_PATH} is added to the search path
3623 @c Keep in sync with aclocal-path-precedence.sh
3624 and takes precedence over system directories (including those found via
3625 @file{dirlist}), with the exception of the versioned directory
3626 @var{acdir-APIVERSION} (@pxref{Macro Search Path}). However, directories
3627 passed via @option{-I} will take precedence over directories in
3630 @c Keep in sync with aclocal-path-installed.sh
3631 Also note that, if the @option{--install} option is used, any @file{.m4}
3632 file containing a required macro that is found in a directory listed in
3633 @env{ACLOCAL_PATH} will be installed locally.
3634 @c Keep in sync with aclocal-path-installed-serial.sh
3635 In this case, serial numbers in @file{.m4} are honored too,
3638 Conversely to @file{dirlist}, @env{ACLOCAL_PATH} is useful if you are
3639 using a global copy of Automake and want @command{aclocal} to look for
3640 macros somewhere under your home directory.
3642 @subsubheading Planned future incompatibilities
3644 The order in which the directories in the macro search path are currently
3645 looked up is confusing and/or suboptimal in various aspects, and is
3646 probably going to be changed in the future Automake release. In
3647 particular, directories in @env{ACLOCAL_PATH} and @file{@var{acdir}}
3648 might end up taking precedence over @file{@var{acdir-APIVERSION}}, and
3649 directories in @file{@var{acdir}/dirlist} might end up taking precedence
3650 over @file{@var{acdir}}. @emph{This is a possible future incompatibility!}
3652 @node Extending aclocal
3653 @subsection Writing your own aclocal macros
3655 @cindex @command{aclocal}, extending
3656 @cindex Extending @command{aclocal}
3658 The @command{aclocal} program doesn't have any built-in knowledge of any
3659 macros, so it is easy to extend it with your own macros.
3661 This can be used by libraries that want to supply their own Autoconf
3662 macros for use by other programs. For instance, the @command{gettext}
3663 library supplies a macro @code{AM_GNU_GETTEXT} that should be used by
3664 any package using @command{gettext}. When the library is installed, it
3665 installs this macro so that @command{aclocal} will find it.
3667 A macro file's name should end in @file{.m4}. Such files should be
3668 installed in @file{$(datadir)/aclocal}. This is as simple as writing:
3670 @c Keep in sync with primary-prefix-couples-documented-valid.sh
3672 aclocaldir = $(datadir)/aclocal
3673 aclocal_DATA = mymacro.m4 myothermacro.m4
3677 Please do use @file{$(datadir)/aclocal}, and not something based on
3678 the result of @samp{aclocal --print-ac-dir} (@pxref{Hard-Coded Install
3679 Paths}, for arguments). It might also be helpful to suggest to
3680 the user to add the @file{$(datadir)/aclocal} directory to his
3681 @env{ACLOCAL_PATH} variable (@pxref{ACLOCAL_PATH}) so that
3682 @command{aclocal} will find the @file{.m4} files installed by your
3683 package automatically.
3685 A file of macros should be a series of properly quoted
3686 @code{AC_DEFUN}'s (@pxref{Macro Definitions, , , autoconf, The
3687 Autoconf Manual}). The @command{aclocal} programs also understands
3688 @code{AC_REQUIRE} (@pxref{Prerequisite Macros, , , autoconf, The
3689 Autoconf Manual}), so it is safe to put each macro in a separate file.
3690 Each file should have no side effects but macro definitions.
3691 Especially, any call to @code{AC_PREREQ} should be done inside the
3692 defined macro, not at the beginning of the file.
3694 @cindex underquoted @code{AC_DEFUN}
3698 Starting with Automake 1.8, @command{aclocal} warns about all
3699 underquoted calls to @code{AC_DEFUN}. We realize this annoys some
3700 people, because @command{aclocal} was not so strict in the past and
3701 many third party macros are underquoted; and we have to apologize for
3702 this temporary inconvenience. The reason we have to be stricter is
3703 that a future implementation of @command{aclocal} (@pxref{Future of
3704 aclocal}) will have to temporarily include all of these third party
3705 @file{.m4} files, maybe several times, even including files that end
3706 up not being needed. Doing so should alleviate many problems of the
3707 current implementation; however, it requires a stricter style from
3708 macro authors. Hopefully it is easy to revise the existing macros.
3715 [AC_REQUIRE([AX_SOMETHING])dnl
3722 should be rewritten as
3725 AC_DEFUN([AX_FOOBAR],
3726 [AC_PREREQ([2.68])dnl
3727 AC_REQUIRE([AX_SOMETHING])dnl
3733 Wrapping the @code{AC_PREREQ} call inside the macro ensures that
3734 Autoconf 2.68 will not be required if @code{AX_FOOBAR} is not used.
3735 Most importantly, quoting the first argument of @code{AC_DEFUN} allows
3736 the macro to be redefined or included twice (otherwise this first
3737 argument would be expanded during the second definition). For
3738 consistency we like to quote even arguments such as @code{2.68} that
3741 If you have been directed here by the @command{aclocal} diagnostic but
3742 are not the maintainer of the implicated macro, you will want to
3743 contact the maintainer of that macro. Please make sure you have the
3744 latest version of the macro and that the problem hasn't already been
3745 reported before doing so: people tend to work faster when they aren't
3748 Another situation where @command{aclocal} is commonly used is to
3749 manage macros that are used locally by the package; @ref{Local
3753 @subsection Handling Local Macros
3755 Feature tests offered by Autoconf do not cover all needs. People
3756 often have to supplement existing tests with their own macros, or
3757 with third-party macros.
3759 There are two ways to organize custom macros in a package.
3761 The first possibility (the historical practice) is to list all your
3762 macros in @file{acinclude.m4}. This file will be included in
3763 @file{aclocal.m4} when you run @command{aclocal}, and its macro(s) will
3764 henceforth be visible to @command{autoconf}. However if it contains
3765 numerous macros, it will rapidly become difficult to maintain, and it
3766 will be almost impossible to share macros between packages.
3768 The second possibility, which we do recommend, is to write each macro
3769 in its own file and gather all these files in a directory. This
3770 directory is usually called @file{m4/}. Then it's enough to update
3771 @file{configure.ac} by adding a proper call to @code{AC_CONFIG_MACRO_DIRS}:
3774 AC_CONFIG_MACRO_DIRS([m4])
3777 @command{aclocal} will then take care of automatically adding @file{m4/}
3778 to its search path for m4 files.
3780 When @samp{aclocal} is run, it will build an @file{aclocal.m4}
3781 that @code{m4_include}s any file from @file{m4/} that defines a
3782 required macro. Macros not found locally will still be searched in
3783 system-wide directories, as explained in @ref{Macro Search Path}.
3785 Custom macros should be distributed for the same reason that
3786 @file{configure.ac} is: so that other people have all the sources of
3787 your package if they want to work on it. In fact, this distribution
3788 happens automatically because all @code{m4_include}d files are
3791 However there is no consensus on the distribution of third-party
3792 macros that your package may use. Many libraries install their own
3793 macro in the system-wide @command{aclocal} directory (@pxref{Extending
3794 aclocal}). For instance, Guile ships with a file called
3795 @file{guile.m4} that contains the macro @code{GUILE_FLAGS} that can
3796 be used to define setup compiler and linker flags appropriate for
3797 using Guile. Using @code{GUILE_FLAGS} in @file{configure.ac} will
3798 cause @command{aclocal} to copy @file{guile.m4} into
3799 @file{aclocal.m4}, but as @file{guile.m4} is not part of the project,
3800 it will not be distributed. Technically, that means a user who
3801 needs to rebuild @file{aclocal.m4} will have to install Guile first.
3802 This is probably OK, if Guile already is a requirement to build the
3803 package. However, if Guile is only an optional feature, or if your
3804 package might run on architectures where Guile cannot be installed,
3805 this requirement will hinder development. An easy solution is to copy
3806 such third-party macros in your local @file{m4/} directory so they get
3809 Since Automake 1.10, @command{aclocal} offers the option @code{--install}
3810 to copy these system-wide third-party macros in your local macro directory,
3811 helping to solve the above problem.
3813 With this setup, system-wide macros will be copied to @file{m4/}
3814 the first time you run @command{aclocal}. Then the locally installed
3815 macros will have precedence over the system-wide installed macros
3816 each time @command{aclocal} is run again.
3818 One reason why you should keep @option{--install} in the flags even
3819 after the first run is that when you later edit @file{configure.ac}
3820 and depend on a new macro, this macro will be installed in your
3821 @file{m4/} automatically. Another one is that serial numbers
3822 (@pxref{Serials}) can be used to update the macros in your source tree
3823 automatically when new system-wide versions are installed. A serial
3824 number should be a single line of the form
3831 where @var{nnn} contains only digits and dots. It should appear in
3832 the M4 file before any macro definition. It is a good practice to
3833 maintain a serial number for each macro you distribute, even if you do
3834 not use the @option{--install} option of @command{aclocal}: this allows
3835 other people to use it.
3839 @subsection Serial Numbers
3840 @cindex serial numbers in macros
3841 @cindex macro serial numbers
3842 @cindex @code{#serial} syntax
3843 @cindex @command{aclocal} and serial numbers
3845 Because third-party macros defined in @file{*.m4} files are naturally
3846 shared between multiple projects, some people like to version them.
3847 This makes it easier to tell which of two M4 files is newer. Since at
3848 least 1996, the tradition is to use a @samp{#serial} line for this.
3850 A serial number should be a single line of the form
3853 # serial @var{version}
3857 where @var{version} is a version number containing only digits and
3858 dots. Usually people use a single integer, and they increment it each
3859 time they change the macro (hence the name of ``serial''). Such a
3860 line should appear in the M4 file before any macro definition.
3862 The @samp{#} must be the first character on the line,
3863 and it is OK to have extra words after the version, as in
3866 #serial @var{version} @var{garbage}
3869 Normally these serial numbers are completely ignored by
3870 @command{aclocal} and @command{autoconf}, like any genuine comment.
3871 However when using @command{aclocal}'s @option{--install} feature, these
3872 serial numbers will modify the way @command{aclocal} selects the
3873 macros to install in the package: if two files with the same basename
3874 exist in your search path, and if at least one of them uses a
3875 @samp{#serial} line, @command{aclocal} will ignore the file that has
3876 the older @samp{#serial} line (or the file that has none).
3878 Note that a serial number applies to a whole M4 file, not to any macro
3879 it contains. A file can contain multiple macros, but only one
3882 Here is a use case that illustrates the use of @option{--install} and
3883 its interaction with serial numbers. Let's assume we maintain a
3884 package called MyPackage, the @file{configure.ac} of which requires a
3885 third-party macro @code{AX_THIRD_PARTY} defined in
3886 @file{/usr/share/aclocal/thirdparty.m4} as follows:
3890 AC_DEFUN([AX_THIRD_PARTY], [...])
3893 MyPackage uses an @file{m4/} directory to store local macros as
3894 explained in @ref{Local Macros}, and has
3897 AC_CONFIG_MACRO_DIRS([m4])
3901 in its @file{configure.ac}.
3903 Initially the @file{m4/} directory is empty. The first time we run
3904 @command{aclocal --install}, it will notice that
3908 @file{configure.ac} uses @code{AX_THIRD_PARTY}
3910 No local macros define @code{AX_THIRD_PARTY}
3912 @file{/usr/share/aclocal/thirdparty.m4} defines @code{AX_THIRD_PARTY}
3913 with serial @w{number 1}.
3917 Because @file{/usr/share/aclocal/thirdparty.m4} is a system-wide macro
3918 and @command{aclocal} was given the @option{--install} option, it will
3919 copy this file in @file{m4/thirdparty.m4}, and output an
3920 @file{aclocal.m4} that contains @samp{m4_include([m4/thirdparty.m4])}.
3922 The next time @samp{aclocal --install} is run, something different
3923 happens. @command{aclocal} notices that
3927 @file{configure.ac} uses @code{AX_THIRD_PARTY}
3929 @file{m4/thirdparty.m4} defines @code{AX_THIRD_PARTY}
3930 with serial @w{number 1}.
3932 @file{/usr/share/aclocal/thirdparty.m4} defines @code{AX_THIRD_PARTY}
3933 with serial @w{number 1}.
3937 Because both files have the same serial number, @command{aclocal} uses
3938 the first it found in its search path order (@pxref{Macro Search
3939 Path}). @command{aclocal} therefore ignores
3940 @file{/usr/share/aclocal/thirdparty.m4} and outputs an
3941 @file{aclocal.m4} that contains @samp{m4_include([m4/thirdparty.m4])}.
3943 Local directories specified with @option{-I} are always searched before
3944 system-wide directories, so a local file will always be preferred to
3945 the system-wide file in case of equal serial numbers.
3947 Now suppose the system-wide third-party macro is changed. This can
3948 happen if the package installing this macro is updated. Let's suppose
3949 the new macro has serial @w{number 2}. The next time @samp{aclocal --install}
3950 is run the situation is the following:
3954 @file{configure.ac} uses @code{AX_THIRD_PARTY}
3956 @file{m4/thirdparty.m4} defines @code{AX_THIRD_PARTY}
3957 with serial @w{number 1}.
3959 @file{/usr/share/aclocal/thirdparty.m4} defines @code{AX_THIRD_PARTY}
3964 When @command{aclocal} sees a greater serial number, it immediately
3965 forgets anything it knows from files that have the same basename and a
3966 smaller serial number. So after it has found
3967 @file{/usr/share/aclocal/thirdparty.m4} with serial 2,
3968 @command{aclocal} will proceed as if it had never seen
3969 @file{m4/thirdparty.m4}. This brings us back to a situation similar
3970 to that at the beginning of our example, where no local file defined
3971 the macro. @command{aclocal} will install the new version of the
3972 macro in @file{m4/thirdparty.m4}, in this case overriding the old
3973 version. MyPackage just had its macro updated as a side effect of
3974 running @command{aclocal}.
3976 If you are leery of letting @command{aclocal} update your local
3977 macro, you can run @samp{aclocal --diff} to review the changes
3978 @samp{aclocal --install} would perform on these macros.
3980 Finally, note that the @option{--force} option of @command{aclocal} has
3981 absolutely no effect on the files installed by @option{--install}. For
3982 instance, if you have modified your local macros, do not expect
3983 @option{--install --force} to replace the local macros by their
3984 system-wide versions. If you want to do so, simply erase the local
3985 macros you want to revert, and run @samp{aclocal --install}.
3988 @node Future of aclocal
3989 @subsection The Future of @command{aclocal}
3990 @cindex @command{aclocal}'s scheduled death
3992 Ideally, @command{aclocal} should not be part of Automake. Automake
3993 should focus on generating @file{Makefile}s; dealing with M4 macros is
3994 more Autoconf's job. The fact that some people install Automake just
3995 to use @command{aclocal}, but do not use @command{automake} otherwise
3996 is an indication of how that feature is misplaced.
3998 The new implementation will probably be done slightly differently.
3999 For instance, it could enforce the @file{m4/}-style layout discussed in
4002 We do not know when or whether this will happen. This has been
4003 discussed several times in the past, but someone still has to commit
4004 to that non-trivial task.
4006 From the user point of view, @command{aclocal}'s removal might turn
4007 out to be painful. There is a simple precaution that you may take to
4008 make that switch more seamless: never call @command{aclocal} yourself.
4009 Keep its invocation under the exclusive control of @command{autoreconf} and
4010 Automake's rebuild rules. Hopefully you won't need to worry about
4011 things breaking; when @command{aclocal} disappears, because everything
4012 will have been taken care of. If otherwise you used to call
4013 @command{aclocal} directly yourself or from some script, you will
4014 quickly notice the change.
4016 Many packages come with a script called @file{bootstrap} or
4017 @file{autogen.sh}, that will just call @command{aclocal},
4018 @command{libtoolize}, @command{gettextize} or @command{autopoint},
4019 @command{autoconf}, @command{autoheader}, and @command{automake} in
4020 the right order. In fact, this is precisely what @command{autoreconf}
4021 can do for you. If your package has such a @file{bootstrap} or
4022 @file{autogen.sh} script, consider using @command{autoreconf}. That
4023 should simplify its logic a lot (less things to maintain, all to the
4024 good), it's even likely you will not need the script anymore, and more
4025 to the point you will not call @command{aclocal} directly anymore.
4027 For the time being, third-party packages should continue to install
4028 public macros into @file{/usr/share/aclocal/}. If @command{aclocal}
4029 is replaced by another tool it might make sense to rename the
4030 directory, but supporting @file{/usr/share/aclocal/} for backward
4031 compatibility should be easy provided all macros are properly written
4032 (@pxref{Extending aclocal}).
4037 @section Autoconf macros supplied with Automake
4039 Automake ships with several Autoconf macros that you can use from your
4040 @file{configure.ac}. When you use one of them it will be included by
4041 @command{aclocal} in @file{aclocal.m4}.
4044 * Public Macros:: Macros that you can use.
4045 * Obsolete Macros:: Macros that will soon be removed.
4046 * Private Macros:: Macros that you should not use.
4049 @c consider generating the following subsections automatically from m4 files.
4052 @subsection Public Macros
4056 @item AM_INIT_AUTOMAKE([@var{options}])
4057 @acindex AM_INIT_AUTOMAKE
4058 Runs many macros required for proper operation of the generated Makefiles.
4060 @vindex AUTOMAKE_OPTIONS
4061 Today, @code{AM_INIT_AUTOMAKE} is called with a single argument: a
4062 space-separated list of Automake options that should be applied to
4063 every @file{Makefile.am} in the tree. The effect is as if
4064 each option were listed in @code{AUTOMAKE_OPTIONS} (@pxref{Options}).
4067 This macro can also be called in another, @emph{deprecated} form:
4068 @code{AM_INIT_AUTOMAKE(PACKAGE, VERSION, [NO-DEFINE])}. In this form,
4069 there are two required arguments: the package and the version number.
4070 This usage is mostly obsolete because the @var{package} and @var{version}
4071 can be obtained from Autoconf's @code{AC_INIT} macro. However,
4072 differently from what happens for @code{AC_INIT} invocations, this
4073 @code{AM_INIT_AUTOMAKE} invocation supports shell variables' expansions
4074 in the @code{PACKAGE} and @code{VERSION} arguments (which otherwise
4075 defaults, respectively, to the @code{PACKAGE_TARNAME} and
4076 @code{PACKAGE_VERSION} defined via the @code{AC_INIT} invocation;
4077 @pxref{AC_INIT, , The @code{AC_INIT} macro, autoconf, The Autoconf Manual});
4078 and this can still be useful in some selected situations.
4079 Our hope is that future Autoconf versions will improve their support
4080 for package versions defined dynamically at configure runtime; when
4081 (and if) this happens, support for the two-args @code{AM_INIT_AUTOMAKE}
4082 invocation will likely be removed from Automake.
4084 @anchor{Modernize AM_INIT_AUTOMAKE invocation}
4085 If your @file{configure.ac} has:
4088 AC_INIT([src/foo.c])
4089 AM_INIT_AUTOMAKE([mumble], [1.5])
4093 you should modernize it as follows:
4096 AC_INIT([mumble], [1.5])
4097 AC_CONFIG_SRCDIR([src/foo.c])
4101 Note that if you're upgrading your @file{configure.ac} from an earlier
4102 version of Automake, it is not always correct to simply move the
4103 package and version arguments from @code{AM_INIT_AUTOMAKE} directly to
4104 @code{AC_INIT}, as in the example above. The first argument to
4105 @code{AC_INIT} should be the name of your package (e.g., @samp{GNU
4106 Automake}), not the tarball name (e.g., @samp{automake}) that you used
4107 to pass to @code{AM_INIT_AUTOMAKE}. Autoconf tries to derive a
4108 tarball name from the package name, which should work for most but not
4109 all package names. (If it doesn't work for yours, you can use the
4110 four-argument form of @code{AC_INIT} to provide the tarball name
4113 @cindex @code{PACKAGE}, prevent definition
4114 @cindex @code{VERSION}, prevent definition
4116 By default this macro @code{AC_DEFINE}'s @code{PACKAGE} and
4117 @code{VERSION}. This can be avoided by passing the @option{no-define}
4118 option (@pxref{List of Automake options}):
4120 AM_INIT_AUTOMAKE([no-define ...])
4123 @item AM_PATH_LISPDIR
4124 @acindex AM_PATH_LISPDIR
4127 Searches for the program @command{emacs}, and, if found, sets the
4128 output variable @code{lispdir} to the full path to Emacs' site-lisp
4131 Note that this test assumes the @command{emacs} found to be a version
4132 that supports Emacs Lisp (such as GNU Emacs or XEmacs). Other
4133 emacsen can cause this test to hang (some, like old versions of
4134 MicroEmacs, start up in interactive mode, requiring @kbd{C-x C-c} to
4135 exit, which is hardly obvious for a non-emacs user). In most cases,
4136 however, you should be able to use @kbd{C-c} to kill the test. In
4137 order to avoid problems, you can set @env{EMACS} to ``no'' in the
4138 environment, or use the @option{--with-lispdir} option to
4139 @command{configure} to explicitly set the correct path (if you're sure
4140 you have an @command{emacs} that supports Emacs Lisp).
4142 @item AM_PROG_AR(@ovar{act-if-fail})
4145 You must use this macro when you use the archiver in your project, if
4146 you want support for unusual archivers such as Microsoft @command{lib}.
4147 The content of the optional argument is executed if the archiver
4148 interface is not recognized; the default action is to abort configure
4149 with an error message.
4155 Use this macro when you have assembly code in your project. This will
4156 choose the assembler for you (by default the C compiler) and set
4157 @code{CCAS}, and will also set @code{CCASFLAGS} if required.
4159 @item AM_PROG_CC_C_O
4160 @acindex AM_PROG_CC_C_O
4161 This is an obsolescent macro that checks that the C compiler supports
4162 the @option{-c} and @option{-o} options together. Note that, since
4163 Automake 1.14, the @code{AC_PROG_CC} is rewritten to implement such
4164 checks itself, and thus the explicit use of @code{AM_PROG_CC_C_O}
4165 should no longer be required.
4167 @item AM_PROG_LEX([@var{options}])
4168 @acindex AM_PROG_LEX
4169 @acindex AC_PROG_LEX
4170 @cindex HP-UX 10, @command{lex} problems
4171 @cindex @command{lex} problems with HP-UX 10
4172 Like @code{AC_PROG_LEX} (@pxref{Particular Programs, , Particular
4173 Program Checks, autoconf, The Autoconf Manual}), but uses the
4174 @command{missing} script on systems that do not have @command{lex}.
4175 HP-UX 10 is one such system. @var{options} are passed directly to
4179 @acindex AM_PROG_GCJ
4182 This macro finds the @command{gcj} program or causes an error. It sets
4183 @code{GCJ} and @code{GCJFLAGS}. @command{gcj} is the Java front-end to the
4184 GNU Compiler Collection.
4186 @item AM_PROG_UPC([@var{compiler-search-list}])
4187 @acindex AM_PROG_UPC
4189 Find a compiler for Unified Parallel C and define the @code{UPC}
4190 variable. The default @var{compiler-search-list} is @samp{upcc upc}.
4191 This macro will abort @command{configure} if no Unified Parallel C
4194 @item AM_MISSING_PROG(@var{name}, @var{program})
4195 @acindex AM_MISSING_PROG
4197 Find a maintainer tool @var{program} and define the @var{name}
4198 environment variable with its location. If @var{program} is not
4199 detected, then @var{name} will instead invoke the @command{missing}
4200 script, in order to give useful advice to the user about the missing
4201 maintainer tool. @xref{maintainer-mode}, for more information on when
4202 the @command{missing} script is appropriate.
4204 @item AM_SILENT_RULES
4205 @acindex AM_SILENT_RULES
4206 Control the machinery for less verbose build output
4207 (@pxref{Automake Silent Rules}).
4209 @item AM_WITH_DMALLOC
4210 @acindex AM_WITH_DMALLOC
4211 @cindex @command{dmalloc}, support for
4212 @vindex WITH_DMALLOC
4213 @opindex --with-dmalloc
4214 Add support for the @uref{https://dmalloc.com/, Dmalloc package}. If
4215 the user runs @command{configure} with @option{--with-dmalloc}, then
4216 define @code{WITH_DMALLOC} and add @option{-ldmalloc} to @code{LIBS}.
4221 @node Obsolete Macros
4222 @subsection Obsolete Macros
4223 @cindex obsolete macros
4226 Although using some of the following macros was required in past
4227 releases, you should not use any of them in new code. @emph{All
4228 these macros will be removed in the next major Automake version};
4229 if you are still using them, running @command{autoupdate} should
4230 adjust your @file{configure.ac} automatically (@pxref{autoupdate
4231 Invocation, , Using @command{autoupdate} to Modernize
4232 @file{configure.ac}, autoconf, The Autoconf Manual}).
4237 @item AM_PROG_MKDIR_P
4238 @acindex AM_PROG_MKDIR_P
4239 @cindex @code{mkdir -p}, macro check
4243 From Automake 1.8 to 1.9.6 this macro used to define the output
4244 variable @code{mkdir_p} to one of @code{mkdir -p}, @code{install-sh
4245 -d}, or @code{mkinstalldirs}.
4247 Nowadays Autoconf provides a similar functionality with
4248 @code{AC_PROG_MKDIR_P} (@pxref{Particular Programs, , Particular
4249 Program Checks, autoconf, The Autoconf Manual}), however this defines
4250 the output variable @code{MKDIR_P} instead. In case you are still
4251 using the @code{AM_PROG_MKDIR_P} macro in your @file{configure.ac},
4252 or its provided variable @code{$(mkdir_p)} in your @file{Makefile.am},
4253 you are advised to switch ASAP to the more modern Autoconf-provided
4254 interface instead; both the macro and the variable might be removed
4255 in a future major Automake release.
4260 @node Private Macros
4261 @subsection Private Macros
4263 The following macros are private macros you should not call directly.
4264 They are called by the other public macros when appropriate. Do not
4265 rely on them, as they might be changed in a future version. Consider
4266 them as implementation details; or better, do not consider them at all:
4270 @item _AM_DEPENDENCIES
4271 @itemx AM_SET_DEPDIR
4273 @itemx AM_OUTPUT_DEPENDENCY_COMMANDS
4274 These macros are used to implement Automake's automatic dependency
4275 tracking scheme. They are called automatically by Automake when
4276 required, and there should be no need to invoke them manually.
4278 @item AM_MAKE_INCLUDE
4279 This macro is used to discover how the user's @command{make} handles
4280 @code{include} statements. This macro is automatically invoked when
4281 needed; there should be no need to invoke it manually.
4283 @item AM_PROG_INSTALL_STRIP
4284 This is used to find a version of @code{install} that can be used to
4285 strip a program at installation time. This macro is automatically
4286 included when required.
4288 @item AM_SANITY_CHECK
4289 This checks to make sure that a file created in the build directory is
4290 newer than a file in the source directory. This can fail on systems
4291 where the clock is set incorrectly. This macro is automatically run
4292 from @code{AM_INIT_AUTOMAKE}.
4298 @chapter Directories
4300 For simple projects that distribute all files in the same directory
4301 it is enough to have a single @file{Makefile.am} that builds
4302 everything in place.
4304 In larger projects, it is common to organize files in different
4305 directories, in a tree. For example, there could be a directory
4306 for the program's source, one for the testsuite, and one for the
4307 documentation; or, for very large projects, there could be one
4308 directory per program, per library or per module.
4310 The traditional approach is to build these subdirectories recursively,
4311 employing @emph{make recursion}: each directory contains its
4312 own @file{Makefile}, and when @command{make} is run from the top-level
4313 directory, it enters each subdirectory in turn, and invokes there a
4314 new @command{make} instance to build the directory's contents.
4316 Because this approach is very widespread, Automake offers built-in
4317 support for it. However, it is worth noting that the use of make
4318 recursion has its own serious issues and drawbacks, and that it's
4319 well possible to have packages with a multi directory layout that
4320 make little or no use of such recursion (examples of such packages
4321 are GNU Bison and GNU Automake itself); see also the @ref{Alternative}
4325 * Subdirectories:: Building subdirectories recursively
4326 * Conditional Subdirectories:: Conditionally not building directories
4327 * Alternative:: Subdirectories without recursion
4328 * Subpackages:: Nesting packages
4331 @node Subdirectories
4332 @section Recursing subdirectories
4334 @cindex @code{SUBDIRS}, explained
4336 In packages using make recursion, the top level @file{Makefile.am} must
4337 tell Automake which subdirectories are to be built. This is done via
4338 the @code{SUBDIRS} variable.
4341 The @code{SUBDIRS} variable holds a list of subdirectories in which
4342 building of various sorts can occur. The rules for many targets
4343 (e.g., @code{all}) in the generated @file{Makefile} will run commands
4344 both locally and in all specified subdirectories. Note that the
4345 directories listed in @code{SUBDIRS} are not required to contain
4346 @file{Makefile.am}s; only @file{Makefile}s (after configuration).
4347 This allows inclusion of libraries from packages that do not use
4348 Automake (such as @code{gettext}; see also @ref{Third-Party
4351 In packages that use subdirectories, the top-level @file{Makefile.am} is
4352 often very short. For instance, here is the @file{Makefile.am} from the
4353 GNU Hello distribution:
4356 EXTRA_DIST = BUGS ChangeLog.O README-alpha
4357 SUBDIRS = doc intl po src tests
4360 When Automake invokes @command{make} in a subdirectory, it uses the value
4361 of the @code{MAKE} variable. It passes the value of the variable
4362 @code{AM_MAKEFLAGS} to the @command{make} invocation; this can be set in
4363 @file{Makefile.am} if there are flags you must always pass to
4366 @vindex AM_MAKEFLAGS
4368 The directories mentioned in @code{SUBDIRS} are usually direct
4369 children of the current directory, each subdirectory containing its
4370 own @file{Makefile.am} with a @code{SUBDIRS} pointing to deeper
4371 subdirectories. Automake can be used to construct packages of
4372 arbitrary depth this way.
4374 By default, Automake generates @file{Makefiles} that work depth-first
4375 in postfix order: the subdirectories are built before the current
4376 directory. However, it is possible to change this ordering. You can
4377 do this by putting @samp{.} into @code{SUBDIRS}. For instance,
4378 putting @samp{.} first will cause a prefix ordering of
4384 SUBDIRS = lib src . test
4388 will cause @file{lib/} to be built before @file{src/}, then the
4389 current directory will be built, finally the @file{test/} directory
4390 will be built. It is customary to arrange test directories to be
4391 built after everything else since they are meant to test what has
4394 In addition to the built-in recursive targets defined by Automake
4395 (@code{all}, @code{check}, etc.), the developer can also define his
4396 own recursive targets. That is done by passing the names of such
4397 targets as arguments to the m4 macro @code{AM_EXTRA_RECURSIVE_TARGETS}
4398 in @file{configure.ac}. Automake generates rules to handle the
4399 recursion for such targets; and the developer can define real actions
4400 for them by defining corresponding @code{-local} targets.
4403 % @kbd{cat configure.ac}
4404 AC_INIT([pkg-name], [1.0])
4406 AM_EXTRA_RECURSIVE_TARGETS([foo])
4407 AC_CONFIG_FILES([Makefile sub/Makefile sub/src/Makefile])
4409 % @kbd{cat Makefile.am}
4412 @@echo This will be run by "make foo".
4413 % @kbd{cat sub/Makefile.am}
4415 % @kbd{cat sub/src/Makefile.am}
4417 @@echo This too will be run by a "make foo" issued either in
4418 @@echo the 'sub/src/' directory, the 'sub/' directory, or the
4419 @@echo top-level directory.
4422 @node Conditional Subdirectories
4423 @section Conditional Subdirectories
4424 @cindex Subdirectories, building conditionally
4425 @cindex Conditional subdirectories
4426 @cindex @code{SUBDIRS}, conditional
4427 @cindex Conditional @code{SUBDIRS}
4429 It is possible to define the @code{SUBDIRS} variable conditionally if,
4430 like in the case of GNU Inetutils, you want to only build a subset of
4433 To illustrate how this works, let's assume we have two directories,
4434 @file{src/} and @file{opt/}. @file{src/} should always be built, but we
4435 want to decide in @command{configure} whether @file{opt/} will be built
4436 or not. (For this example we will assume that @file{opt/} should be
4437 built when the variable @samp{$want_opt} was set to @samp{yes}.)
4439 Running @command{make} should thus recurse into @file{src/} always, and
4440 then maybe in @file{opt/}.
4442 However @samp{make dist} should always recurse into both @file{src/}
4443 and @file{opt/}, because @file{opt/} should be distributed even if it
4444 is not needed in the current configuration. This means
4445 @file{opt/Makefile} should be created @emph{unconditionally}.
4447 There are two ways to set up a project like this. You can use Automake
4448 conditionals (@pxref{Conditionals}) or use Autoconf @code{AC_SUBST}
4449 variables (@pxref{Setting Output Variables, , Setting Output
4450 Variables, autoconf, The Autoconf Manual}). Using Automake
4451 conditionals is the preferred solution. Before we illustrate these
4452 two possibilities, let's introduce @code{DIST_SUBDIRS}.
4455 * SUBDIRS vs DIST_SUBDIRS:: Two sets of directories
4456 * Subdirectories with AM_CONDITIONAL:: Specifying conditional subdirectories
4457 * Subdirectories with AC_SUBST:: Another way for conditional recursion
4458 * Unconfigured Subdirectories:: Not even creating a @samp{Makefile}
4461 @node SUBDIRS vs DIST_SUBDIRS
4462 @subsection @code{SUBDIRS} vs.@: @code{DIST_SUBDIRS}
4463 @cindex @code{DIST_SUBDIRS}, explained
4465 Automake considers two sets of directories, defined by the variables
4466 @code{SUBDIRS} and @code{DIST_SUBDIRS}.
4468 @code{SUBDIRS} contains the subdirectories of the current directory
4469 that must be built (@pxref{Subdirectories}). It must be defined
4470 manually; Automake will never guess a directory is to be built. As we
4471 will see in the next two sections, it is possible to define it
4472 conditionally so that some directory will be omitted from the build.
4474 @code{DIST_SUBDIRS} is used in rules that need to recurse in all
4475 directories, even those that have been conditionally left out of the
4476 build. Recall our example where we may not want to build subdirectory
4477 @file{opt/}, but yet we want to distribute it? This is where
4478 @code{DIST_SUBDIRS} comes into play: @samp{opt} may not appear in
4479 @code{SUBDIRS}, but it must appear in @code{DIST_SUBDIRS}.
4481 Precisely, @code{DIST_SUBDIRS} is used by @samp{make
4482 maintainer-clean}, @samp{make distclean} and @samp{make dist}. All
4483 other recursive rules use @code{SUBDIRS}.
4485 If @code{SUBDIRS} is defined conditionally using Automake
4486 conditionals, Automake will define @code{DIST_SUBDIRS} automatically
4487 from the possible values of @code{SUBDIRS} in all conditions.
4489 If @code{SUBDIRS} contains @code{AC_SUBST} variables,
4490 @code{DIST_SUBDIRS} will not be defined correctly because Automake
4491 does not know the possible values of these variables. In this case
4492 @code{DIST_SUBDIRS} needs to be defined manually.
4494 @node Subdirectories with AM_CONDITIONAL
4495 @subsection Subdirectories with @code{AM_CONDITIONAL}
4496 @cindex @code{SUBDIRS} and @code{AM_CONDITIONAL}
4497 @cindex @code{AM_CONDITIONAL} and @code{SUBDIRS}
4499 @c Keep in sync with subdir-am-cond.sh
4501 @file{configure} should output the @file{Makefile} for each directory
4502 and define a condition into which @file{opt/} should be built.
4506 AM_CONDITIONAL([COND_OPT], [test "$want_opt" = yes])
4507 AC_CONFIG_FILES([Makefile src/Makefile opt/Makefile])
4511 Then @code{SUBDIRS} can be defined in the top-level @file{Makefile.am}
4518 SUBDIRS = src $(MAYBE_OPT)
4521 As you can see, running @command{make} will rightly recurse into
4522 @file{src/} and maybe @file{opt/}.
4524 @vindex DIST_SUBDIRS
4525 As you can't see, running @samp{make dist} will recurse into both
4526 @file{src/} and @file{opt/} directories because @samp{make dist}, unlike
4527 @samp{make all}, doesn't use the @code{SUBDIRS} variable. It uses the
4528 @code{DIST_SUBDIRS} variable.
4530 In this case Automake will define @samp{DIST_SUBDIRS = src opt}
4531 automatically because it knows that @code{MAYBE_OPT} can contain
4532 @samp{opt} in some condition.
4534 @node Subdirectories with AC_SUBST
4535 @subsection Subdirectories with @code{AC_SUBST}
4536 @cindex @code{SUBDIRS} and @code{AC_SUBST}
4537 @cindex @code{AC_SUBST} and @code{SUBDIRS}
4539 @c Keep in sync with subdir-ac-subst.sh
4541 Another possibility is to define @code{MAYBE_OPT} from
4542 @file{./configure} using @code{AC_SUBST}:
4546 if test "$want_opt" = yes; then
4551 AC_SUBST([MAYBE_OPT])
4552 AC_CONFIG_FILES([Makefile src/Makefile opt/Makefile])
4556 In this case the top-level @file{Makefile.am} should look as follows.
4559 SUBDIRS = src $(MAYBE_OPT)
4560 DIST_SUBDIRS = src opt
4563 The drawback is that since Automake cannot guess what the possible
4564 values of @code{MAYBE_OPT} are, it is necessary to define
4565 @code{DIST_SUBDIRS}.
4567 @node Unconfigured Subdirectories
4568 @subsection Unconfigured Subdirectories
4569 @cindex Subdirectories, configured conditionally
4571 The semantics of @code{DIST_SUBDIRS} are often misunderstood by some
4572 users that try to @emph{configure and build} subdirectories
4573 conditionally. Here by configuring we mean creating the
4574 @file{Makefile} (it might also involve running a nested
4575 @command{configure} script: this is a costly operation that explains
4576 why people want to do it conditionally, but only the @file{Makefile}
4577 is relevant to the discussion).
4579 The above examples all assume that every @file{Makefile} is created,
4580 even in directories that are not going to be built. The simple reason
4581 is that we want @samp{make dist} to distribute even the directories
4582 that are not being built (e.g., platform-dependent code), hence
4583 @file{make dist} must recurse into the subdirectory, hence this
4584 directory must be configured and appear in @code{DIST_SUBDIRS}.
4586 Building packages that do not configure every subdirectory is a tricky
4587 business, and we do not recommend it to the novice as it is easy to
4588 produce an incomplete tarball by mistake. We will not discuss this
4589 topic in depth here, yet for the adventurous here are a few rules to
4594 @item @code{SUBDIRS} should always be a subset of @code{DIST_SUBDIRS}.
4596 It makes little sense to have a directory in @code{SUBDIRS} that
4597 is not in @code{DIST_SUBDIRS}. Think of the former as a way to tell
4598 which directories listed in the latter should be built.
4599 @item Any directory listed in @code{DIST_SUBDIRS} and @code{SUBDIRS}
4602 That is, the @file{Makefile} must exist or the recursive @command{make}
4603 rules will not be able to process the directory.
4604 @item Any configured directory must be listed in @code{DIST_SUBDIRS}.
4606 This is so the cleaning rules remove the generated @file{Makefile}s.
4607 It would be correct to see @code{DIST_SUBDIRS} as a variable that
4608 lists all the directories that have been configured.
4612 In order to prevent recursion in some unconfigured directory you
4613 must therefore ensure that this directory does not appear in
4614 @code{DIST_SUBDIRS} (and @code{SUBDIRS}). For instance, if you define
4615 @code{SUBDIRS} conditionally using @code{AC_SUBST} and do not define
4616 @code{DIST_SUBDIRS} explicitly, it will be default to
4617 @samp{$(SUBDIRS)}; another possibility is to force @code{DIST_SUBDIRS
4620 Of course, directories that are omitted from @code{DIST_SUBDIRS} will
4621 not be distributed unless you make other arrangements for this to
4622 happen (for instance, always running @samp{make dist} in a
4623 configuration where all directories are known to appear in
4624 @code{DIST_SUBDIRS}; or writing a @code{dist-hook} target to
4625 distribute these directories).
4627 @cindex Subdirectories, not distributed
4628 In a few packages, unconfigured directories are not even expected to
4629 be distributed. Although these packages do not require the
4630 aforementioned extra arrangements, there is another pitfall. If the
4631 name of a directory appears in @code{SUBDIRS} or @code{DIST_SUBDIRS},
4632 @command{automake} will make sure the directory exists. Consequently
4633 @command{automake} cannot be run on such a distribution when one
4634 directory has been omitted. One way to avoid this check is to use the
4635 @code{AC_SUBST} method to declare conditional directories; since
4636 @command{automake} does not know the values of @code{AC_SUBST}
4637 variables it cannot ensure the corresponding directory exists.
4640 @section An Alternative Approach to Subdirectories
4642 If you've ever read Peter Miller's excellent paper, @cite{Recursive
4643 Make Considered Harmful}, the preceding sections on the use of make
4644 recursion will probably come as unwelcome advice. For those who
4645 haven't read the paper, Miller's main thesis is that recursive
4646 @command{make} invocations are both slow and error-prone.
4648 Automake is intended to have sufficient cross-directory support to
4649 enable you to write a single @file{Makefile.am} for a complex
4650 multi-directory package. (If it seems to be lacking, please report
4651 the issue as usual.)
4653 By default an installable file specified in a subdirectory will have its
4654 directory name stripped before installation. For instance, in this
4655 example, the header file will be installed as
4656 @file{$(includedir)/stdio.h}:
4659 include_HEADERS = inc/stdio.h
4663 @cindex @code{nobase_} prefix
4664 @cindex Path stripping, avoiding
4665 @cindex Avoiding path stripping
4667 However, the @samp{nobase_} prefix can be used to circumvent this path
4668 stripping. In this example, the header file will be installed as
4669 @file{$(includedir)/sys/types.h}:
4672 nobase_include_HEADERS = sys/types.h
4675 @cindex @code{nobase_} and @code{dist_} or @code{nodist_}
4676 @cindex @code{dist_} and @code{nobase_}
4677 @cindex @code{nodist_} and @code{nobase_}
4681 @samp{nobase_} should be specified first when used in conjunction with
4682 either @samp{dist_} or @samp{nodist_} (@pxref{Fine-grained Distribution
4683 Control}). For instance:
4686 nobase_dist_pkgdata_DATA = images/vortex.pgm sounds/whirl.ogg
4689 Finally, note that a variable using the @samp{nobase_} prefix can
4690 often be replaced by several variables, one for each destination
4691 directory (@pxref{Uniform}). For instance, the last example could be
4692 rewritten as follows:
4694 @c Keep in sync with primary-prefix-couples-documented-valid.sh
4696 imagesdir = $(pkgdatadir)/images
4697 soundsdir = $(pkgdatadir)/sounds
4698 dist_images_DATA = images/vortex.pgm
4699 dist_sounds_DATA = sounds/whirl.ogg
4703 This latter syntax makes it possible to change one destination
4704 directory without changing the layout of the source tree.
4706 Currently, @samp{nobase_*_LTLIBRARIES} are the only exception to this
4707 rule, in that there is no particular installation order guarantee for
4708 an otherwise equivalent set of variables without @samp{nobase_} prefix.
4711 @section Nesting Packages
4712 @cindex Nesting packages
4714 @acindex AC_CONFIG_SUBDIRS
4715 @acindex AC_CONFIG_AUX_DIR
4717 In the GNU Build System, packages can be nested to arbitrary depth.
4718 This means that a package can embed other packages with their own
4719 @file{configure}, @file{Makefile}s, etc.
4721 These other packages should just appear as subdirectories of their
4722 parent package. They must be listed in @code{SUBDIRS} like other
4723 ordinary directories. However the subpackage's @file{Makefile}s
4724 should be output by its own @file{configure} script, not by the
4725 parent's @file{configure}. This is achieved using the
4726 @code{AC_CONFIG_SUBDIRS} Autoconf macro (@pxref{Subdirectories,
4727 AC_CONFIG_SUBDIRS, Configuring Other Packages in Subdirectories,
4728 autoconf, The Autoconf Manual}).
4730 Here is an example package for an @code{arm} program that links with
4731 a @code{hand} library that is a nested package in subdirectory
4734 @code{arm}'s @file{configure.ac}:
4737 AC_INIT([arm], [1.0])
4738 AC_CONFIG_AUX_DIR([.])
4741 AC_CONFIG_FILES([Makefile])
4742 # Call hand's ./configure script recursively.
4743 AC_CONFIG_SUBDIRS([hand])
4747 @code{arm}'s @file{Makefile.am}:
4750 # Build the library in the hand subdirectory first.
4753 # Include hand's header when compiling this directory.
4754 AM_CPPFLAGS = -I$(srcdir)/hand
4758 # link with the hand library.
4759 arm_LDADD = hand/libhand.a
4762 Now here is @code{hand}'s @file{hand/configure.ac}:
4765 AC_INIT([hand], [1.2])
4766 AC_CONFIG_AUX_DIR([.])
4771 AC_CONFIG_FILES([Makefile])
4776 and its @file{hand/Makefile.am}:
4779 lib_LIBRARIES = libhand.a
4780 libhand_a_SOURCES = hand.c
4783 When @samp{make dist} is run from the top-level directory it will
4784 create an archive @file{arm-1.0.tar.gz} that contains the @code{arm}
4785 code as well as the @file{hand} subdirectory. This package can be
4786 built and installed like any ordinary package, with the usual
4787 @samp{./configure && make && make install} sequence (the @code{hand}
4788 subpackage will be built and installed by the process).
4790 When @samp{make dist} is run from the hand directory, it will create a
4791 self-contained @file{hand-1.2.tar.gz} archive. So although it appears
4792 to be embedded in another package, it can still be used separately.
4794 The purpose of the @samp{AC_CONFIG_AUX_DIR([.])} instruction is to
4795 force Automake and Autoconf to search for auxiliary scripts in the
4796 current directory. For instance, this means that there will be two
4797 copies of @file{install-sh}: one in the top-level of the @code{arm}
4798 package, and another one in the @file{hand/} subdirectory for the
4799 @code{hand} package.
4801 The historical default is to search for these auxiliary scripts in the
4802 parent directory and the grandparent directory. So if the
4803 @samp{AC_CONFIG_AUX_DIR([.])} line was removed from
4804 @file{hand/configure.ac}, that subpackage would share the auxiliary
4805 script of the @code{arm} package. This may look like a gain in size
4806 (a few kilobytes), but more importantly, it is a loss of modularity as
4807 the @code{hand} subpackage is no longer self-contained (@samp{make
4808 dist} in the subdirectory will not work anymore).
4810 Packages that do not use Automake need more work to be integrated this
4811 way. @xref{Third-Party Makefiles}.
4814 @chapter Building Programs and Libraries
4816 A large part of Automake's functionality is dedicated to making it easy
4817 to build programs and libraries.
4820 * A Program:: Building a program
4821 * A Library:: Building a library
4822 * A Shared Library:: Building a Libtool library
4823 * Program and Library Variables:: Variables controlling program and
4825 * Default _SOURCES:: Default source files
4826 * LIBOBJS:: Special handling for LIBOBJS and ALLOCA
4827 * Program Variables:: Variables used when building a program
4828 * Yacc and Lex:: Yacc and Lex support
4829 * C++ Support:: Compiling C++ sources
4830 * Objective C Support:: Compiling Objective C sources
4831 * Objective C++ Support:: Compiling Objective C++ sources
4832 * Unified Parallel C Support:: Compiling Unified Parallel C sources
4833 * Assembly Support:: Compiling assembly sources
4834 * Fortran 77 Support:: Compiling Fortran 77 sources
4835 * Fortran 9x Support:: Compiling Fortran 9x sources
4836 * Java Support with gcj:: Compiling Java sources using gcj
4837 * Vala Support:: Compiling Vala sources
4838 * Support for Other Languages:: Compiling other languages
4839 * Dependencies:: Automatic dependency tracking
4840 * EXEEXT:: Support for executable extensions
4845 @section Building a program
4847 In order to build a program, you need to tell Automake which sources
4848 are part of it, and which libraries it should be linked with.
4850 This section also covers conditional compilation of sources or
4851 programs. Most of the comments about these also apply to libraries
4852 (@pxref{A Library}) and libtool libraries (@pxref{A Shared Library}).
4855 * Program Sources:: Defining program sources
4856 * Linking:: Linking with libraries or extra objects
4857 * Conditional Sources:: Handling conditional sources
4858 * Conditional Programs:: Building a program conditionally
4861 @node Program Sources
4862 @subsection Defining program sources
4864 @cindex @code{PROGRAMS}, @code{bindir}
4866 @vindex bin_PROGRAMS
4867 @vindex sbin_PROGRAMS
4868 @vindex libexec_PROGRAMS
4869 @vindex pkglibexec_PROGRAMS
4870 @vindex noinst_PROGRAMS
4871 @vindex check_PROGRAMS
4873 In a directory containing source that gets built into a program (as
4874 opposed to a library or a script), the @code{PROGRAMS} primary is used.
4875 Programs can be installed in @code{bindir}, @code{sbindir},
4876 @code{libexecdir}, @code{pkglibexecdir}, or not at all
4877 (@code{noinst_}). They can also be built only for @samp{make check}, in
4878 which case the prefix is @samp{check_}.
4883 bin_PROGRAMS = hello
4886 In this simple case, the resulting @file{Makefile.in} will contain code
4887 to generate a program named @code{hello}.
4889 Associated with each program are several assisting variables that are
4890 named after the program. These variables are all optional, and have
4891 reasonable defaults. Each variable, its use, and default is spelled out
4892 below; we use the ``hello'' example throughout.
4894 The variable @code{hello_SOURCES} is used to specify which source files
4895 get built into an executable:
4898 hello_SOURCES = hello.c version.c getopt.c getopt1.c getopt.h system.h
4901 This causes each mentioned @file{.c} file to be compiled into the
4902 corresponding @file{.o}. Then all are linked to produce @file{hello}.
4904 @cindex @code{_SOURCES} primary, defined
4905 @cindex @code{SOURCES} primary, defined
4906 @cindex Primary variable, @code{SOURCES}
4909 If @code{hello_SOURCES} is not specified, then it defaults to the single
4910 file @file{hello.c} (@pxref{Default _SOURCES}).
4914 Multiple programs can be built in a single directory. Multiple programs
4915 can share a single source file, which must be listed in each
4916 @code{_SOURCES} definition.
4918 @cindex Header files in @code{_SOURCES}
4919 @cindex @code{_SOURCES} and header files
4921 Header files listed in a @code{_SOURCES} definition will be included in
4922 the distribution but otherwise ignored. In case it isn't obvious, you
4923 should not include the header file generated by @file{configure} in a
4924 @code{_SOURCES} variable; this file should not be distributed. Lex
4925 (@file{.l}) and Yacc (@file{.y}) files can also be listed; see @ref{Yacc
4930 @subsection Linking the program
4932 If you need to link against libraries that are not found by
4933 @command{configure}, you can use @code{LDADD} to do so. This variable is
4934 used to specify additional objects or libraries to link with; it is
4935 inappropriate for specifying specific linker flags; you should use
4936 @code{AM_LDFLAGS} for this purpose.
4940 @cindex @code{prog_LDADD}, defined
4942 Sometimes, multiple programs are built in one directory but do not share
4943 the same link-time requirements. In this case, you can use the
4944 @code{@var{prog}_LDADD} variable (where @var{prog} is the name of the
4945 program as it appears in some @code{_PROGRAMS} variable, and usually
4946 written in lowercase) to override @code{LDADD}. If this variable exists
4947 for a given program, then that program is not linked using @code{LDADD}.
4950 For instance, in GNU cpio, @code{pax}, @code{cpio} and @code{mt} are
4951 linked against the library @file{libcpio.a}. However, @code{rmt} is
4952 built in the same directory, and has no such link requirement. Also,
4953 @code{mt} and @code{rmt} are only built on certain architectures. Here
4954 is what cpio's @file{src/Makefile.am} looks like (abridged):
4957 bin_PROGRAMS = cpio pax $(MT)
4958 libexec_PROGRAMS = $(RMT)
4959 EXTRA_PROGRAMS = mt rmt
4961 LDADD = ../lib/libcpio.a $(INTLLIBS)
4964 cpio_SOURCES = @dots{}
4965 pax_SOURCES = @dots{}
4966 mt_SOURCES = @dots{}
4967 rmt_SOURCES = @dots{}
4970 @cindex @code{_LDFLAGS}, defined
4971 @vindex maude_LDFLAGS
4972 @code{@var{prog}_LDADD} is inappropriate for passing program-specific
4973 linker flags (except for @option{-l}, @option{-L}, @option{-dlopen} and
4974 @option{-dlpreopen}). So, use the @code{@var{prog}_LDFLAGS} variable for
4977 @cindex @code{_DEPENDENCIES}, defined
4978 @vindex maude_DEPENDENCIES
4979 @vindex EXTRA_maude_DEPENDENCIES
4980 It is also occasionally useful to have a program depend on some other
4981 target that is not in fact part of that program. This can be done
4982 using either the @code{@var{prog}_DEPENDENCIES} or the
4983 @code{EXTRA_@var{prog}_DEPENDENCIES} variable. Each program depends on
4984 the contents both variables, but no further interpretation is done.
4986 Since these dependencies are associated to the link rule used to
4987 create the programs they should normally list files used by the link
4988 command. That is @file{*.$(OBJEXT)}, @file{*.a}, or @file{*.la}
4989 files. In rare cases you may need to add other kinds of files such as
4990 linker scripts, but @emph{listing a source file in
4991 @code{_DEPENDENCIES} is wrong}. If some source file needs to be built
4992 before all the components of a program are built, consider using the
4993 @code{BUILT_SOURCES} variable instead (@pxref{Sources}).
4995 If @code{@var{prog}_DEPENDENCIES} is not supplied, it is computed by
4996 Automake. The automatically-assigned value is the contents of
4997 @code{@var{prog}_LDADD}, with most configure substitutions, @option{-l},
4998 @option{-L}, @option{-dlopen} and @option{-dlpreopen} options removed. The
4999 configure substitutions that are left in are only @samp{$(LIBOBJS)} and
5000 @samp{$(ALLOCA)}; these are left because it is known that they will not
5001 cause an invalid value for @code{@var{prog}_DEPENDENCIES} to be
5004 @ref{Conditional Sources} shows a situation where @code{_DEPENDENCIES}
5007 The @code{EXTRA_@var{prog}_DEPENDENCIES} may be useful for cases where
5008 you merely want to augment the @command{automake}-generated
5009 @code{@var{prog}_DEPENDENCIES} rather than replacing it.
5011 @cindex @code{LDADD} and @option{-l}
5012 @cindex @option{-l} and @code{LDADD}
5013 We recommend that you avoid using @option{-l} options in @code{LDADD}
5014 or @code{@var{prog}_LDADD} when referring to libraries built by your
5015 package. Instead, write the file name of the library explicitly as in
5016 the above @code{cpio} example. Use @option{-l} only to list
5017 third-party libraries. If you follow this rule, the default value of
5018 @code{@var{prog}_DEPENDENCIES} will list all your local libraries and
5019 omit the other ones.
5022 @node Conditional Sources
5023 @subsection Conditional compilation of sources
5025 You can't put a configure substitution (e.g., @samp{@@FOO@@} or
5026 @samp{$(FOO)} where @code{FOO} is defined via @code{AC_SUBST}) into a
5027 @code{_SOURCES} variable. The reason for this is a bit hard to
5028 explain, but suffice to say that it simply won't work. Automake will
5029 give an error if you try to do this.
5031 Fortunately there are two other ways to achieve the same result. One is
5032 to use configure substitutions in @code{_LDADD} variables, the other is
5033 to use an Automake conditional.
5035 @subsubheading Conditional Compilation using @code{_LDADD} Substitutions
5037 @cindex @code{EXTRA_prog_SOURCES}, defined
5039 Automake must know all the source files that could possibly go into a
5040 program, even if not all the files are built in every circumstance. Any
5041 files that are only conditionally built should be listed in the
5042 appropriate @code{EXTRA_} variable. For instance, if
5043 @file{hello-linux.c} or @file{hello-generic.c} were conditionally included
5044 in @code{hello}, the @file{Makefile.am} would contain:
5047 bin_PROGRAMS = hello
5048 hello_SOURCES = hello-common.c
5049 EXTRA_hello_SOURCES = hello-linux.c hello-generic.c
5050 hello_LDADD = $(HELLO_SYSTEM)
5051 hello_DEPENDENCIES = $(HELLO_SYSTEM)
5055 You can then set up the @samp{$(HELLO_SYSTEM)} substitution from
5056 @file{configure.ac}:
5061 *linux*) HELLO_SYSTEM='hello-linux.$(OBJEXT)' ;;
5062 *) HELLO_SYSTEM='hello-generic.$(OBJEXT)' ;;
5064 AC_SUBST([HELLO_SYSTEM])
5068 In this case, the variable @code{HELLO_SYSTEM} should be replaced by
5069 either @file{hello-linux.o} or @file{hello-generic.o}, and added to
5070 both @code{hello_DEPENDENCIES} and @code{hello_LDADD} in order to be
5071 built and linked in.
5073 @subsubheading Conditional Compilation using Automake Conditionals
5075 An often simpler way to compile source files conditionally is to use
5076 Automake conditionals. For instance, you could use this
5077 @file{Makefile.am} construct to build the same @file{hello} example:
5080 bin_PROGRAMS = hello
5082 hello_SOURCES = hello-linux.c hello-common.c
5084 hello_SOURCES = hello-generic.c hello-common.c
5088 In this case, @file{configure.ac} should set up the @code{LINUX}
5089 conditional using @code{AM_CONDITIONAL} (@pxref{Conditionals}).
5091 When using conditionals like this you don't need to use the
5092 @code{EXTRA_} variable, because Automake will examine the contents of
5093 each variable to construct the complete list of source files.
5095 If your program uses a lot of files, you will probably prefer a
5096 conditional @samp{+=}.
5099 bin_PROGRAMS = hello
5100 hello_SOURCES = hello-common.c
5102 hello_SOURCES += hello-linux.c
5104 hello_SOURCES += hello-generic.c
5108 @node Conditional Programs
5109 @subsection Conditional compilation of programs
5110 @cindex Conditional programs
5111 @cindex Programs, conditional
5113 Sometimes it is useful to determine the programs that are to be built
5114 at configure time. For instance, GNU @code{cpio} only builds
5115 @code{mt} and @code{rmt} under special circumstances. The means to
5116 achieve conditional compilation of programs are the same you can use
5117 to compile source files conditionally: substitutions or conditionals.
5119 @subsubheading Conditional Programs using @command{configure} Substitutions
5121 @vindex EXTRA_PROGRAMS
5122 @cindex @code{EXTRA_PROGRAMS}, defined
5123 In this case, you must notify Automake of all the programs that can
5124 possibly be built, but at the same time cause the generated
5125 @file{Makefile.in} to use the programs specified by @command{configure}.
5126 This is done by having @command{configure} substitute values into each
5127 @code{_PROGRAMS} definition, while listing all optionally built programs
5128 in @code{EXTRA_PROGRAMS}.
5131 bin_PROGRAMS = cpio pax $(MT)
5132 libexec_PROGRAMS = $(RMT)
5133 EXTRA_PROGRAMS = mt rmt
5136 As explained in @ref{EXEEXT}, Automake will rewrite
5137 @code{bin_PROGRAMS}, @code{libexec_PROGRAMS}, and
5138 @code{EXTRA_PROGRAMS}, appending @samp{$(EXEEXT)} to each binary.
5139 Obviously it cannot rewrite values obtained at run-time through
5140 @command{configure} substitutions, therefore you should take care of
5141 appending @samp{$(EXEEXT)} yourself, as in @samp{AC_SUBST([MT],
5142 ['mt$@{EXEEXT@}'])}.
5144 @subsubheading Conditional Programs using Automake Conditionals
5146 You can also use Automake conditionals (@pxref{Conditionals}) to
5147 select programs to be built. In this case you don't have to worry
5148 about @samp{$(EXEEXT)} or @code{EXTRA_PROGRAMS}.
5150 @c Keep in sync with exeext.sh
5152 bin_PROGRAMS = cpio pax
5157 libexec_PROGRAMS = rmt
5163 @section Building a library
5165 @cindex @code{_LIBRARIES} primary, defined
5166 @cindex @code{LIBRARIES} primary, defined
5167 @cindex Primary variable, @code{LIBRARIES}
5170 @vindex lib_LIBRARIES
5171 @vindex pkglib_LIBRARIES
5172 @vindex noinst_LIBRARIES
5174 Building a library is much like building a program. In this case, the
5175 name of the primary is @code{LIBRARIES}. Libraries can be installed in
5176 @code{libdir} or @code{pkglibdir}.
5178 @xref{A Shared Library}, for information on how to build shared
5179 libraries using libtool and the @code{LTLIBRARIES} primary.
5181 Each @code{_LIBRARIES} variable is a list of the libraries to be built.
5182 For instance, to create a library named @file{libcpio.a}, but not install
5183 it, you would write:
5186 noinst_LIBRARIES = libcpio.a
5187 libcpio_a_SOURCES = @dots{}
5190 The sources that go into a library are determined exactly as they are
5191 for programs, via the @code{_SOURCES} variables. Note that the library
5192 name is canonicalized (@pxref{Canonicalization}), so the @code{_SOURCES}
5193 variable corresponding to @file{libcpio.a} is @samp{libcpio_a_SOURCES},
5194 not @samp{libcpio.a_SOURCES}.
5196 @vindex maude_LIBADD
5197 Extra objects can be added to a library using the
5198 @code{@var{library}_LIBADD} variable. This should be used for objects
5199 determined by @command{configure}. Again from @code{cpio}:
5201 @c Keep in sync with pr401c.sh
5203 libcpio_a_LIBADD = $(LIBOBJS) $(ALLOCA)
5206 In addition, sources for extra objects that will not exist until
5207 configure-time must be added to the @code{BUILT_SOURCES} variable
5210 Building a static library is done by compiling all object files, then
5211 by invoking @samp{$(AR) $(ARFLAGS)} followed by the name of the
5212 library and the list of objects, and finally by calling
5213 @samp{$(RANLIB)} on that library. You should call
5214 @code{AC_PROG_RANLIB} from your @file{configure.ac} to define
5215 @code{RANLIB} (Automake will complain otherwise). You should also
5216 call @code{AM_PROG_AR} to define @code{AR}, in order to support unusual
5217 archivers such as Microsoft lib. @code{ARFLAGS} will default to
5218 @code{cr}; you can override this variable by setting it in your
5219 @file{Makefile.am} or by @code{AC_SUBST}ing it from your
5220 @file{configure.ac}. You can override the @code{AR} variable by
5221 defining a per-library @code{maude_AR} variable (@pxref{Program and
5222 Library Variables}).
5224 @cindex Empty libraries
5225 Be careful when selecting library components conditionally. Because
5226 building an empty library is not portable, you should ensure that any
5227 library always contains at least one object.
5229 To use a static library when building a program, add it to
5230 @code{LDADD} for this program. In the following example, the program
5231 @file{cpio} is statically linked with the library @file{libcpio.a}.
5234 noinst_LIBRARIES = libcpio.a
5235 libcpio_a_SOURCES = @dots{}
5238 cpio_SOURCES = cpio.c @dots{}
5239 cpio_LDADD = libcpio.a
5243 @node A Shared Library
5244 @section Building a Shared Library
5246 @cindex Shared libraries, support for
5248 Building shared libraries portably is a relatively complex matter.
5249 For this reason, GNU Libtool (@pxref{Top, , Introduction, libtool, The
5250 Libtool Manual}) was created to help build shared libraries in a
5251 platform-independent way.
5254 * Libtool Concept:: Introducing Libtool
5255 * Libtool Libraries:: Declaring Libtool Libraries
5256 * Conditional Libtool Libraries:: Building Libtool Libraries Conditionally
5257 * Conditional Libtool Sources:: Choosing Library Sources Conditionally
5258 * Libtool Convenience Libraries:: Building Convenience Libtool Libraries
5259 * Libtool Modules:: Building Libtool Modules
5260 * Libtool Flags:: Using _LIBADD, _LDFLAGS, and _LIBTOOLFLAGS
5261 * LTLIBOBJS:: Using $(LTLIBOBJS) and $(LTALLOCA)
5262 * Libtool Issues:: Common Issues Related to Libtool's Use
5265 @node Libtool Concept
5266 @subsection The Libtool Concept
5268 @cindex @command{libtool}, introduction
5269 @cindex libtool library, definition
5270 @cindex suffix @file{.la}, defined
5271 @cindex @file{.la} suffix, defined
5273 Libtool abstracts shared and static libraries into a unified concept
5274 henceforth called @dfn{libtool libraries}. Libtool libraries are
5275 files using the @file{.la} suffix, and can designate a static library,
5276 a shared library, or maybe both. Their exact nature cannot be
5277 determined until @file{./configure} is run: not all platforms support
5278 all kinds of libraries, and users can explicitly select which
5279 libraries should be built. (However the package's maintainers can
5280 tune the default; @pxref{LT_INIT, , The @code{LT_INIT}
5281 macro, libtool, The Libtool Manual}.)
5283 @cindex suffix @file{.lo}, defined
5284 Because object files for shared and static libraries must be compiled
5285 differently, libtool is also used during compilation. Object files
5286 built by libtool are called @dfn{libtool objects}: these are files
5287 using the @file{.lo} suffix. Libtool libraries are built from these
5290 You should not assume anything about the structure of @file{.la} or
5291 @file{.lo} files and how libtool constructs them: this is libtool's
5292 concern, and the last thing one wants is to learn about libtool's
5293 guts. However the existence of these files matters, because they are
5294 used as targets and dependencies in @file{Makefile}s' rules when
5295 building libtool libraries. There are situations where you may have
5296 to refer to these, for instance when expressing dependencies for
5297 building source files conditionally (@pxref{Conditional Libtool
5300 @cindex @file{libltdl}, introduction
5302 People considering writing a plug-in system, with dynamically loaded
5303 modules, should look into @file{libltdl}: libtool's dlopening library
5304 (@pxref{Using libltdl, , Using libltdl, libtool, The Libtool Manual}).
5305 This offers a portable dlopening facility to load libtool libraries
5306 dynamically, and can also achieve static linking where unavoidable.
5308 Before we discuss how to use libtool with Automake in detail, it
5309 should be noted that the libtool manual also has a section about how
5310 to use Automake with libtool (@pxref{Using Automake, , Using Automake
5311 with Libtool, libtool, The Libtool Manual}).
5313 @node Libtool Libraries
5314 @subsection Building Libtool Libraries
5316 @cindex @code{_LTLIBRARIES} primary, defined
5317 @cindex @code{LTLIBRARIES} primary, defined
5318 @cindex Primary variable, @code{LTLIBRARIES}
5319 @cindex Example of shared libraries
5320 @vindex lib_LTLIBRARIES
5321 @vindex pkglib_LTLIBRARIES
5322 @vindex _LTLIBRARIES
5324 Automake uses libtool to build libraries declared with the
5325 @code{LTLIBRARIES} primary. Each @code{_LTLIBRARIES} variable is a
5326 list of libtool libraries to build. For instance, to create a libtool
5327 library named @file{libgettext.la}, and install it in @code{libdir},
5331 lib_LTLIBRARIES = libgettext.la
5332 libgettext_la_SOURCES = gettext.c gettext.h @dots{}
5335 Automake predefines the variable @code{pkglibdir}, so you can use
5336 @code{pkglib_LTLIBRARIES} to install libraries in
5337 @samp{$(libdir)/@@PACKAGE@@/}.
5339 If @file{gettext.h} is a public header file that needs to be installed
5340 in order for people to use the library, it should be declared using a
5341 @code{_HEADERS} variable, not in @code{libgettext_la_SOURCES}.
5342 Headers listed in the latter should be internal headers that are not
5343 part of the public interface.
5346 lib_LTLIBRARIES = libgettext.la
5347 libgettext_la_SOURCES = gettext.c @dots{}
5348 include_HEADERS = gettext.h @dots{}
5351 A package can build and install such a library along with other
5352 programs that use it. This dependency should be specified using
5353 @code{LDADD}. The following example builds a program named
5354 @file{hello} that is linked with @file{libgettext.la}.
5357 lib_LTLIBRARIES = libgettext.la
5358 libgettext_la_SOURCES = gettext.c @dots{}
5360 bin_PROGRAMS = hello
5361 hello_SOURCES = hello.c @dots{}
5362 hello_LDADD = libgettext.la
5366 Whether @file{hello} is statically or dynamically linked with
5367 @file{libgettext.la} is not yet known: this will depend on the
5368 configuration of libtool and the capabilities of the host.
5371 @node Conditional Libtool Libraries
5372 @subsection Building Libtool Libraries Conditionally
5373 @cindex libtool libraries, conditional
5374 @cindex conditional libtool libraries
5376 Like conditional programs (@pxref{Conditional Programs}), there are
5377 two main ways to build conditional libraries: using Automake
5378 conditionals or using Autoconf @code{AC_SUBST}itutions.
5380 The important implementation detail you have to be aware of is that
5381 the place where a library will be installed matters to libtool: it
5382 needs to be indicated @emph{at link-time} using the @option{-rpath}
5385 For libraries whose destination directory is known when Automake runs,
5386 Automake will automatically supply the appropriate @option{-rpath}
5387 option to libtool. This is the case for libraries listed explicitly in
5388 some installable @code{_LTLIBRARIES} variables such as
5389 @code{lib_LTLIBRARIES}.
5391 However, for libraries determined at configure time (and thus
5392 mentioned in @code{EXTRA_LTLIBRARIES}), Automake does not know the
5393 final installation directory. For such libraries you must add the
5394 @option{-rpath} option to the appropriate @code{_LDFLAGS} variable by
5397 The examples below illustrate the differences between these two methods.
5399 Here is an example where @code{WANTEDLIBS} is an @code{AC_SUBST}ed
5400 variable set at @file{./configure}-time to either @file{libfoo.la},
5401 @file{libbar.la}, both, or none. Although @samp{$(WANTEDLIBS)}
5402 appears in the @code{lib_LTLIBRARIES}, Automake cannot guess it
5403 relates to @file{libfoo.la} or @file{libbar.la} at the time it creates
5404 the link rule for these two libraries. Therefore the @option{-rpath}
5405 argument must be explicitly supplied.
5407 @c Keep in sync with ltcond.sh
5409 EXTRA_LTLIBRARIES = libfoo.la libbar.la
5410 lib_LTLIBRARIES = $(WANTEDLIBS)
5411 libfoo_la_SOURCES = foo.c @dots{}
5412 libfoo_la_LDFLAGS = -rpath '$(libdir)'
5413 libbar_la_SOURCES = bar.c @dots{}
5414 libbar_la_LDFLAGS = -rpath '$(libdir)'
5417 Here is how the same @file{Makefile.am} would look using Automake
5418 conditionals named @code{WANT_LIBFOO} and @code{WANT_LIBBAR}. Now
5419 Automake is able to compute the @option{-rpath} setting itself, because
5420 it's clear that both libraries will end up in @samp{$(libdir)} if they
5423 @c Keep in sync with ltcond.sh
5427 lib_LTLIBRARIES += libfoo.la
5430 lib_LTLIBRARIES += libbar.la
5432 libfoo_la_SOURCES = foo.c @dots{}
5433 libbar_la_SOURCES = bar.c @dots{}
5436 @node Conditional Libtool Sources
5437 @subsection Libtool Libraries with Conditional Sources
5439 Conditional compilation of sources in a library can be achieved in the
5440 same way as conditional compilation of sources in a program
5441 (@pxref{Conditional Sources}). The only difference is that
5442 @code{_LIBADD} should be used instead of @code{_LDADD} and that it
5443 should mention libtool objects (@file{.lo} files).
5445 So, to mimic the @file{hello} example from @ref{Conditional Sources},
5446 we could build a @file{libhello.la} library using either
5447 @file{hello-linux.c} or @file{hello-generic.c} with the following
5450 @c Keep in sync with ltcond2.sh
5452 lib_LTLIBRARIES = libhello.la
5453 libhello_la_SOURCES = hello-common.c
5454 EXTRA_libhello_la_SOURCES = hello-linux.c hello-generic.c
5455 libhello_la_LIBADD = $(HELLO_SYSTEM)
5456 libhello_la_DEPENDENCIES = $(HELLO_SYSTEM)
5460 And make sure @command{configure} defines @code{HELLO_SYSTEM} as
5461 either @file{hello-linux.lo} or @file{hello-@-generic.lo}.
5463 Or we could simply use an Automake conditional as follows.
5465 @c Keep in sync with ltcond2.sh
5467 lib_LTLIBRARIES = libhello.la
5468 libhello_la_SOURCES = hello-common.c
5470 libhello_la_SOURCES += hello-linux.c
5472 libhello_la_SOURCES += hello-generic.c
5476 @node Libtool Convenience Libraries
5477 @subsection Libtool Convenience Libraries
5478 @cindex convenience libraries, libtool
5479 @cindex libtool convenience libraries
5480 @vindex noinst_LTLIBRARIES
5481 @vindex check_LTLIBRARIES
5483 Sometimes you want to build libtool libraries that should not be
5484 installed. These are called @dfn{libtool convenience libraries} and
5485 are typically used to encapsulate many sublibraries, later gathered
5486 into one big installed library.
5488 Libtool convenience libraries are declared by directory-less variables
5489 such as @code{noinst_LTLIBRARIES}, @code{check_LTLIBRARIES}, or even
5490 @code{EXTRA_LTLIBRARIES}. Unlike installed libtool libraries they do
5491 not need an @option{-rpath} flag at link time (this is in fact the only
5494 Convenience libraries listed in @code{noinst_LTLIBRARIES} are always
5495 built. Those listed in @code{check_LTLIBRARIES} are built only upon
5496 @samp{make check}. Finally, libraries listed in
5497 @code{EXTRA_LTLIBRARIES} are never built explicitly: Automake outputs
5498 rules to build them, but if the library does not appear as a @file{Makefile}
5499 dependency anywhere it won't be built (this is why
5500 @code{EXTRA_LTLIBRARIES} is used for conditional compilation).
5502 Here is a sample setup merging libtool convenience libraries from
5503 subdirectories into one main @file{libtop.la} library.
5505 @c Keep in sync with ltconv.sh
5507 # -- Top-level Makefile.am --
5508 SUBDIRS = sub1 sub2 @dots{}
5509 lib_LTLIBRARIES = libtop.la
5511 libtop_la_LIBADD = \
5516 # -- sub1/Makefile.am --
5517 noinst_LTLIBRARIES = libsub1.la
5518 libsub1_la_SOURCES = @dots{}
5520 # -- sub2/Makefile.am --
5521 # showing nested convenience libraries
5522 SUBDIRS = sub2.1 sub2.2 @dots{}
5523 noinst_LTLIBRARIES = libsub2.la
5524 libsub2_la_SOURCES =
5525 libsub2_la_LIBADD = \
5531 When using such a setup, beware that @command{automake} will assume
5532 @file{libtop.la} is to be linked with the C linker. This is because
5533 @code{libtop_la_SOURCES} is empty, so @command{automake} picks C as
5534 default language. If @code{libtop_la_SOURCES} was not empty,
5535 @command{automake} would select the linker as explained in @ref{How
5536 the Linker is Chosen}.
5538 If one of the sublibraries contains non-C source, it is important that
5539 the appropriate linker be chosen. One way to achieve this is to
5540 pretend that there is such a non-C file among the sources of the
5541 library, thus forcing @command{automake} to select the appropriate
5542 linker. Here is the top-level @file{Makefile} of our example updated
5543 to force C++ linking.
5546 SUBDIRS = sub1 sub2 @dots{}
5547 lib_LTLIBRARIES = libtop.la
5549 # Dummy C++ source to cause C++ linking.
5550 nodist_EXTRA_libtop_la_SOURCES = dummy.cxx
5551 libtop_la_LIBADD = \
5557 @samp{EXTRA_*_SOURCES} variables are used to keep track of source
5558 files that might be compiled (this is mostly useful when doing
5559 conditional compilation using @code{AC_SUBST}; @pxref{Conditional
5560 Libtool Sources}), and the @code{nodist_} prefix means the listed
5561 sources are not to be distributed (@pxref{Program and Library
5562 Variables}). In effect the file @file{dummy.cxx} does not need to
5563 exist in the source tree. Of course if you have some real source file
5564 to list in @code{libtop_la_SOURCES} there is no point in cheating with
5565 @code{nodist_EXTRA_libtop_la_SOURCES}.
5568 @node Libtool Modules
5569 @subsection Libtool Modules
5570 @cindex modules, libtool
5571 @cindex libtool modules
5572 @cindex @option{-module}, libtool
5574 These are libtool libraries meant to be dlopened. They are
5575 indicated to libtool by passing @option{-module} at link-time.
5578 pkglib_LTLIBRARIES = mymodule.la
5579 mymodule_la_SOURCES = doit.c
5580 mymodule_la_LDFLAGS = -module
5583 Ordinarily, Automake requires that a library's name start with
5584 @code{lib}. However, when building a dynamically loadable module you
5585 might wish to use a "nonstandard" name. Automake will not complain
5586 about such nonstandard names if it knows the library being built is a
5587 libtool module, i.e., if @option{-module} explicitly appears in the
5588 library's @code{_LDFLAGS} variable (or in the common @code{AM_LDFLAGS}
5589 variable when no per-library @code{_LDFLAGS} variable is defined).
5591 As always, @code{AC_SUBST} variables are black boxes to Automake since
5592 their values are not yet known when @command{automake} is run.
5593 Therefore if @option{-module} is set via such a variable, Automake
5594 cannot notice it and will proceed as if the library was an ordinary
5595 libtool library, with strict naming.
5597 If @code{mymodule_la_SOURCES} is not specified, then it defaults to
5598 the single file @file{mymodule.c} (@pxref{Default _SOURCES}).
5601 @subsection @code{_LIBADD}, @code{_LDFLAGS}, and @code{_LIBTOOLFLAGS}
5602 @cindex @code{_LIBADD}, libtool
5603 @cindex @code{_LDFLAGS}, libtool
5604 @cindex @code{_LIBTOOLFLAGS}, libtool
5605 @vindex AM_LIBTOOLFLAGS
5606 @vindex LIBTOOLFLAGS
5607 @vindex maude_LIBTOOLFLAGS
5609 As shown in previous sections, the @samp{@var{library}_LIBADD}
5610 variable should be used to list extra libtool objects (@file{.lo}
5611 files) or libtool libraries (@file{.la}) to add to @var{library}.
5613 The @samp{@var{library}_LDFLAGS} variable is the place to list
5614 additional libtool linking flags, such as @option{-version-info},
5615 @option{-static}, and a lot more. @xref{Link mode, , Link mode,
5616 libtool, The Libtool Manual}.
5618 The @command{libtool} command has two kinds of options: mode-specific
5619 options and generic options. Mode-specific options such as the
5620 aforementioned linking flags should be lumped with the other flags
5621 passed to the tool invoked by @command{libtool} (hence the use of
5622 @samp{@var{library}_LDFLAGS} for libtool linking flags). Generic
5623 options include @option{--tag=@var{tag}} and @option{--silent}
5624 (@pxref{Invoking libtool, , Invoking @command{libtool}, libtool, The
5625 Libtool Manual} for more options). They should appear before the mode
5626 selection on the command line; in @file{Makefile.am}s they should
5627 be listed in the @samp{@var{library}_LIBTOOLFLAGS} variable.
5629 If @samp{@var{library}_LIBTOOLFLAGS} is not defined, then the variable
5630 @code{AM_LIBTOOLFLAGS} is used instead.
5632 These flags are passed to libtool after the @option{--tag=@var{tag}}
5633 option computed by Automake (if any), so
5634 @samp{@var{library}_LIBTOOLFLAGS} (or @code{AM_LIBTOOLFLAGS}) is a
5635 good place to override or supplement the @option{--tag=@var{tag}}
5638 The libtool rules also use a @code{LIBTOOLFLAGS} variable that should
5639 not be set in @file{Makefile.am}: this is a user variable (@pxref{Flag
5640 Variables Ordering}). It allows users to run @samp{make
5641 LIBTOOLFLAGS=--silent}, for instance. Note that the verbosity of
5642 @command{libtool} can also be influenced by the Automake support
5643 for silent rules (@pxref{Automake Silent Rules}).
5645 @node LTLIBOBJS, Libtool Issues, Libtool Flags, A Shared Library
5646 @subsection @code{LTLIBOBJS} and @code{LTALLOCA}
5647 @cindex @code{LTLIBOBJS}, special handling
5648 @cindex @code{LIBOBJS}, and Libtool
5649 @cindex @code{LTALLOCA}, special handling
5650 @cindex @code{ALLOCA}, and Libtool
5657 Where an ordinary library might include @samp{$(LIBOBJS)} or
5658 @samp{$(ALLOCA)} (@pxref{LIBOBJS}), a libtool library must use
5659 @samp{$(LTLIBOBJS)} or @samp{$(LTALLOCA)}. This is required because
5660 the object files that libtool operates on do not necessarily end in
5663 Nowadays, the computation of @code{LTLIBOBJS} from @code{LIBOBJS} is
5664 performed automatically by Autoconf (@pxref{AC_LIBOBJ vs LIBOBJS, ,
5665 @code{AC_LIBOBJ} vs.@: @code{LIBOBJS}, autoconf, The Autoconf Manual}).
5667 @node Libtool Issues
5668 @subsection Common Issues Related to Libtool's Use
5671 * Error required file ltmain.sh not found:: The need to run libtoolize
5672 * Objects created both with libtool and without:: Avoid a specific build race
5675 @node Error required file ltmain.sh not found
5676 @subsubsection Error: @samp{required file `./ltmain.sh' not found}
5677 @cindex @file{ltmain.sh} not found
5678 @cindex @command{libtoolize}, no longer run by @command{automake}
5679 @cindex @command{libtoolize} and @command{autoreconf}
5680 @cindex @command{autoreconf} and @command{libtoolize}
5681 @cindex @file{bootstrap} and @command{autoreconf}
5682 @cindex @file{autogen.sh} and @command{autoreconf}
5684 Libtool comes with a tool called @command{libtoolize} that will
5685 install libtool's supporting files into a package. Running this
5686 command will install @file{ltmain.sh}. You should execute it before
5687 @command{aclocal} and @command{automake}.
5689 People upgrading old packages to newer autotools are likely to face
5690 this issue because older Automake versions used to call
5691 @command{libtoolize}. Therefore old build scripts do not call
5692 @command{libtoolize}.
5694 Since Automake 1.6, it has been decided that running
5695 @command{libtoolize} was not Automake's business. Instead, that
5696 functionality has been moved into the @command{autoreconf} command
5697 (@pxref{autoreconf Invocation, , Using @command{autoreconf}, autoconf,
5698 The Autoconf Manual}). If you do not want to remember what to run and
5699 when, just remember the @command{autoreconf} command. Hopefully,
5700 replacing existing @file{bootstrap} or @file{autogen.sh} scripts by a
5701 call to @command{autoreconf} should also free you from any similar
5702 incompatible change in the future.
5704 @node Objects created both with libtool and without
5705 @subsubsection Objects @samp{created with both libtool and without}
5707 Sometimes, the same source file is used both to build a libtool
5708 library and to build another non-libtool target (be it a program or
5711 Let's consider the following @file{Makefile.am}.
5715 prog_SOURCES = prog.c foo.c @dots{}
5717 lib_LTLIBRARIES = libfoo.la
5718 libfoo_la_SOURCES = foo.c @dots{}
5722 (In this trivial case the issue could be avoided by linking
5723 @file{libfoo.la} with @file{prog} instead of listing @file{foo.c} in
5724 @code{prog_SOURCES}. But let's assume we want to keep @file{prog} and
5725 @file{libfoo.la} separate.)
5727 Technically, it means that we should build @file{foo.$(OBJEXT)} for
5728 @file{prog}, and @file{foo.lo} for @file{libfoo.la}. The problem is
5729 that in the course of creating @file{foo.lo}, libtool may erase (or
5730 replace) @file{foo.$(OBJEXT)}, and this cannot be avoided.
5732 Therefore, when Automake detects this situation it will complain
5733 with a message such as
5735 object 'foo.$(OBJEXT)' created both with libtool and without
5738 A workaround for this issue is to ensure that these two objects get
5739 different basenames. As explained in @ref{Renamed Objects}, this
5740 happens automatically when per-target flags are used.
5744 prog_SOURCES = prog.c foo.c @dots{}
5745 prog_CFLAGS = $(AM_CFLAGS)
5747 lib_LTLIBRARIES = libfoo.la
5748 libfoo_la_SOURCES = foo.c @dots{}
5752 Adding @samp{prog_CFLAGS = $(AM_CFLAGS)} is almost a no-op, because
5753 when the @code{prog_CFLAGS} is defined, it is used instead of
5754 @code{AM_CFLAGS}. However as a side effect it will cause
5755 @file{prog.c} and @file{foo.c} to be compiled as
5756 @file{prog-prog.$(OBJEXT)} and @file{prog-foo.$(OBJEXT)}, which solves
5759 @node Program and Library Variables
5760 @section Program and Library Variables
5762 Associated with each program is a collection of variables that can be
5763 used to modify how that program is built. There is a similar list of
5764 such variables for each library. The canonical name of the program (or
5765 library) is used as a base for naming these variables.
5767 In the list below, we use the name ``maude'' to refer to the program or
5768 library. In your @file{Makefile.am} you would replace this with the
5769 canonical name of your program. This list also refers to ``maude'' as a
5770 program, but in general the same rules apply for both static and dynamic
5771 libraries; the documentation below notes situations where programs and
5776 This variable, if it exists, lists all the source files that are
5777 compiled to build the program. These files are added to the
5778 distribution by default. When building the program, Automake will cause
5779 each source file to be compiled to a single @file{.o} file (or
5780 @file{.lo} when using libtool). Normally these object files are named
5781 after the source file, but other factors can change this. If a file in
5782 the @code{_SOURCES} variable has an unrecognized extension, Automake
5783 will do one of two things with it. If a suffix rule exists for turning
5784 files with the unrecognized extension into @file{.o} files, then
5785 @command{automake} will treat this file as it will any other source file
5786 (@pxref{Support for Other Languages}). Otherwise, the file will be
5787 ignored as though it were a header file.
5789 The prefixes @code{dist_} and @code{nodist_} can be used to control
5790 whether files listed in a @code{_SOURCES} variable are distributed.
5791 @code{dist_} is redundant, as sources are distributed by default, but it
5792 can be specified for clarity if desired.
5794 It is possible to have both @code{dist_} and @code{nodist_} variants of
5795 a given @code{_SOURCES} variable at once; this lets you easily
5796 distribute some files and not others, for instance:
5799 nodist_maude_SOURCES = nodist.c
5800 dist_maude_SOURCES = dist-me.c
5803 By default the output file (on Unix systems, the @file{.o} file) will
5804 be put into the current build directory. However, if the option
5805 @option{subdir-objects} is in effect in the current directory then the
5806 @file{.o} file will be put into the subdirectory named after the
5807 source file. For instance, with @option{subdir-objects} enabled,
5808 @file{sub/dir/file.c} will be compiled to @file{sub/dir/file.o}. Some
5809 projects prefer or require this mode of operation. You can specify
5810 @option{subdir-objects} in @code{AUTOMAKE_OPTIONS} (@pxref{Options}).
5811 @cindex Subdirectory, objects in
5812 @cindex Objects in subdirectory
5814 @c https://bugs.gnu.org/20699
5815 When @option{subdir-objects} is specified, and source files which lie
5816 outside the current directory tree are nevertheless specified, as in
5817 @code{foo_SOURCES = ../lib/other.c}, Automake will still remove
5818 @file{../lib/other.o}, in fact, @file{../lib/*.o} (e.g., at @code{make
5819 clean}, even though it is arguably wrong for one subdirectory to
5820 clean in a sibling. This may or may not be changed in the future.
5822 @item EXTRA_maude_SOURCES
5823 Automake needs to know the list of files you intend to compile
5824 @emph{statically}. For one thing, this is the only way Automake has of
5825 knowing what sort of language support a given @file{Makefile.in}
5826 requires. (There are other, more obscure reasons for
5827 this limitation as well.) This means that, for example, you can't put a
5828 configure substitution like @samp{@@my_sources@@} into a @samp{_SOURCES}
5829 variable. If you intend to conditionally compile source files and use
5830 @file{configure} to substitute the appropriate object names into, e.g.,
5831 @code{_LDADD} (see below), then you should list the corresponding source
5832 files in the @code{EXTRA_} variable.
5834 This variable also supports @code{dist_} and @code{nodist_} prefixes.
5835 For instance, @code{nodist_EXTRA_maude_SOURCES} would list extra
5836 sources that may need to be built, but should not be distributed.
5839 A static library is created by default by invoking @samp{$(AR)
5840 $(ARFLAGS)} followed by the name of the library and then the objects
5841 being put into the library. You can override this by setting the
5842 @code{_AR} variable. This is usually used with C++; some C++
5843 compilers require a special invocation in order to instantiate all the
5844 templates that should go into a library. For instance, the SGI C++
5845 compiler likes this variable set like so:
5847 libmaude_a_AR = $(CXX) -ar -o
5851 A static library's index is updated by default by invoking @samp{$(RANLIB)}
5852 followed by the name of the library. You can override this by setting the
5853 @code{_RANLIB} variable.
5856 Extra objects can be added to a @emph{library} using the @code{_LIBADD}
5857 variable. For instance, this should be used for objects determined by
5858 @command{configure} (@pxref{A Library}).
5860 In the case of libtool libraries, @code{maude_LIBADD} can also refer
5861 to other libtool libraries.
5864 Extra objects (@file{*.$(OBJEXT)}) and libraries (@file{*.a},
5865 @file{*.la}) can be added to a @emph{program} by listing them in the
5866 @code{_LDADD} variable. For instance, this should be used for objects
5867 determined by @command{configure} (@pxref{Linking}).
5869 @code{_LDADD} and @code{_LIBADD} are inappropriate for passing
5870 program-specific linker flags (except for @option{-l}, @option{-L},
5871 @option{-dlopen} and @option{-dlpreopen}). Use the @code{_LDFLAGS} variable
5874 For instance, if your @file{configure.ac} uses @code{AC_PATH_XTRA}, you
5875 could link your program against the X libraries like so:
5878 maude_LDADD = $(X_PRE_LIBS) $(X_LIBS) $(X_EXTRA_LIBS)
5881 We recommend that you use @option{-l} and @option{-L} only when
5882 referring to third-party libraries, and give the explicit file names
5883 of any library built by your package. Doing so will ensure that
5884 @code{maude_DEPENDENCIES} (see below) is correctly defined by default.
5887 This variable is used to pass extra flags to the link step of a program
5888 or a shared library. It overrides the @code{AM_LDFLAGS} variable,
5889 even if it is defined only in a false branch of a conditional; in
5890 other words, if @code{@var{prog}_LDFLAGS} is defined at all,
5891 @code{AM_LDFLAGS} will not be used.
5892 @c https://bugs.gnu.org/34925
5894 @item maude_LIBTOOLFLAGS
5895 This variable is used to pass extra options to @command{libtool}.
5896 It overrides the @code{AM_LIBTOOLFLAGS} variable.
5897 These options are output before @command{libtool}'s @option{--mode=@var{mode}}
5898 option, so they should not be mode-specific options (those belong to
5899 the compiler or linker flags). @xref{Libtool Flags}.
5901 @item maude_DEPENDENCIES
5902 @itemx EXTRA_maude_DEPENDENCIES
5903 It is also occasionally useful to have a target (program or library)
5904 depend on some other file that is not in fact part of that target.
5905 This can be done using the @code{_DEPENDENCIES} variable. Each
5906 target depends on the contents of such a variable, but no further
5907 interpretation is done.
5909 Since these dependencies are associated with the link rule used to
5910 create the programs they should normally list files used by the link
5911 command. That is @file{*.$(OBJEXT)}, @file{*.a}, or @file{*.la} files
5912 for programs; @file{*.lo} and @file{*.la} files for Libtool libraries;
5913 and @file{*.$(OBJEXT)} files for static libraries. In rare cases you
5914 may need to add other kinds of files such as linker scripts, but
5915 @emph{listing a source file in @code{_DEPENDENCIES} is wrong}. If
5916 some source file needs to be built before all the components of a
5917 program are built, consider using the @code{BUILT_SOURCES} variable
5920 If @code{_DEPENDENCIES} is not supplied, it is computed by Automake.
5921 The automatically-assigned value is the contents of @code{_LDADD} or
5922 @code{_LIBADD}, with most configure substitutions, @option{-l}, @option{-L},
5923 @option{-dlopen} and @option{-dlpreopen} options removed. The configure
5924 substitutions that are left in are only @samp{$(LIBOBJS)} and
5925 @samp{$(ALLOCA)}; these are left because it is known that they will not
5926 cause an invalid value for @code{_DEPENDENCIES} to be generated.
5928 @code{_DEPENDENCIES} is more likely used to perform conditional
5929 compilation using an @code{AC_SUBST} variable that contains a list of
5930 objects. @xref{Conditional Sources}, and @ref{Conditional Libtool
5933 The @code{EXTRA_*_DEPENDENCIES} variable may be useful for cases where
5934 you merely want to augment the @command{automake}-generated
5935 @code{_DEPENDENCIES} variable rather than replacing it.
5938 You can override the linker on a per-program basis. By default the
5939 linker is chosen according to the languages used by the program. For
5940 instance, a program that includes C++ source code would use the C++
5941 compiler to link. The @code{_LINK} variable must hold the name of a
5942 command that can be passed all the @file{.o} file names and libraries
5943 to link against as arguments. Note that the name of the underlying
5944 program is @emph{not} passed to @code{_LINK}; typically one uses
5948 maude_LINK = $(CCLD) -magic -o $@@
5951 If a @code{_LINK} variable is not supplied, it may still be generated
5952 and used by Automake due to the use of per-target link flags such as
5953 @code{_CFLAGS}, @code{_LDFLAGS} or @code{_LIBTOOLFLAGS}, in cases where
5956 If the variable @code{AM_V_*_LINK} exists, it is used to output a
5957 status line in silent mode; otherwise, @code{AM_V_GEN} is used.
5959 @item maude_CCASFLAGS
5961 @itemx maude_CPPFLAGS
5962 @itemx maude_CXXFLAGS
5964 @itemx maude_GCJFLAGS
5966 @itemx maude_OBJCFLAGS
5967 @itemx maude_OBJCXXFLAGS
5969 @itemx maude_UPCFLAGS
5971 @cindex per-target compilation flags, defined
5972 Automake allows you to set compilation flags on a per-program (or
5973 per-library) basis. A single source file can be included in several
5974 programs, and it will potentially be compiled with different flags for
5975 each program. This works for any language directly supported by
5976 Automake. These @dfn{per-target compilation flags} are
5985 @samp{_OBJCXXFLAGS},
5987 @samp{_UPCFLAGS}, and
5990 When using a per-target compilation flag, Automake will choose a
5991 different name for the intermediate object files. Ordinarily a file
5992 like @file{sample.c} will be compiled to produce @file{sample.o}.
5993 However, if the program's @code{_CFLAGS} variable is set, then the
5994 object file will be named, for instance, @file{maude-sample.o}. (See
5995 also @ref{Renamed Objects}.)
5997 In compilations with per-target flags, the ordinary @samp{AM_} form of
5998 the flags variable is @emph{not} automatically included in the
5999 compilation (however, the user form of the variable @emph{is} included).
6000 So for instance, if you want the hypothetical @file{maude} compilations
6001 to also use the value of @code{AM_CFLAGS}, you would need to write:
6004 maude_CFLAGS = @dots{} your flags @dots{} $(AM_CFLAGS)
6007 @xref{Flag Variables Ordering}, for more discussion about the
6008 interaction between user variables, @samp{AM_} shadow variables, and
6009 per-target variables.
6011 @item maude_SHORTNAME
6012 On some platforms the allowable file names are very short. In order to
6013 support these systems and per-target compilation flags at the same
6014 time, Automake allows you to set a ``short name'' that will influence
6015 how intermediate object files are named. For instance, in the following
6019 bin_PROGRAMS = maude
6020 maude_CPPFLAGS = -DSOMEFLAG
6022 maude_SOURCES = sample.c @dots{}
6026 the object file would be named @file{m-sample.o} rather than
6027 @file{maude-sample.o}.
6029 This facility is rarely needed in practice,
6030 and we recommend avoiding it until you find it is required.
6033 @node Default _SOURCES
6034 @section Default @code{_SOURCES}
6038 @cindex @code{_SOURCES}, default
6039 @cindex default @code{_SOURCES}
6040 @vindex AM_DEFAULT_SOURCE_EXT
6042 @code{_SOURCES} variables are used to specify source files of programs
6043 (@pxref{A Program}), libraries (@pxref{A Library}), and Libtool
6044 libraries (@pxref{A Shared Library}).
6046 When no such variable is specified for a target, Automake will define
6047 one itself. The default is to compile a single C file whose base name
6048 is the name of the target itself, with any extension replaced by
6049 @code{AM_DEFAULT_SOURCE_EXT}, which defaults to @file{.c}.
6051 For example if you have the following somewhere in your
6052 @file{Makefile.am} with no corresponding @code{libfoo_a_SOURCES}:
6055 lib_LIBRARIES = libfoo.a sub/libc++.a
6059 @file{libfoo.a} will be built using a default source file named
6060 @file{libfoo.c}, and @file{sub/libc++.a} will be built from
6061 @file{sub/libc++.c}. (In older versions @file{sub/libc++.a}
6062 would be built from @file{sub_libc___a.c}, i.e., the default source
6063 was the canonicalized name of the target, with @file{.c} appended.
6064 We believe the new behavior is more sensible, but for backward
6065 compatibility @command{automake} will use the old name if a file or a rule
6066 with that name exists and @code{AM_DEFAULT_SOURCE_EXT} is not used.)
6068 @cindex @code{check_PROGRAMS} example
6069 @vindex check_PROGRAMS
6070 Default sources are mainly useful in test suites, when building many
6071 test programs each from a single source. For instance, in
6074 check_PROGRAMS = test1 test2 test3
6075 AM_DEFAULT_SOURCE_EXT = .cpp
6079 @file{test1}, @file{test2}, and @file{test3} will be built
6080 from @file{test1.cpp}, @file{test2.cpp}, and @file{test3.cpp}.
6081 Without the last line, they will be built from @file{test1.c},
6082 @file{test2.c}, and @file{test3.c}.
6084 @cindex Libtool modules, default source example
6085 @cindex default source, Libtool modules example
6086 Another case where this is convenient is building many Libtool modules
6087 (@file{module@var{n}.la}), each defined in its own file
6088 (@file{module@var{n}.c}).
6091 AM_LDFLAGS = -module
6092 lib_LTLIBRARIES = module1.la module2.la module3.la
6095 @cindex empty @code{_SOURCES}
6096 @cindex @code{_SOURCES}, empty
6097 Finally, there is one situation where this default source computation
6098 needs to be avoided: when a target should not be built from sources.
6099 We already saw such an example in @ref{true}; this happens when all
6100 the constituents of a target have already been compiled and just need
6101 to be combined using a @code{_LDADD} variable. Then it is necessary
6102 to define an empty @code{_SOURCES} variable, so that @command{automake}
6103 does not compute a default.
6106 bin_PROGRAMS = target
6108 target_LDADD = libmain.a libmisc.a
6112 @section Special handling for @code{LIBOBJS} and @code{ALLOCA}
6114 @cindex @code{LIBOBJS}, example
6115 @cindex @code{ALLOCA}, example
6116 @cindex @code{LIBOBJS}, special handling
6117 @cindex @code{ALLOCA}, special handling
6123 The @samp{$(LIBOBJS)} and @samp{$(ALLOCA)} variables list object
6124 files that should be compiled into the project to provide an
6125 implementation for functions that are missing or broken on the host
6126 system. They are substituted by @file{configure}.
6130 These variables are defined by Autoconf macros such as
6131 @code{AC_LIBOBJ}, @code{AC_REPLACE_FUNCS} (@pxref{Generic Functions, ,
6132 Generic Function Checks, autoconf, The Autoconf Manual}), or
6133 @code{AC_FUNC_ALLOCA} (@pxref{Particular Functions, , Particular
6134 Function Checks, autoconf, The Autoconf Manual}). Many other Autoconf
6135 macros call @code{AC_LIBOBJ} or @code{AC_REPLACE_FUNCS} to
6136 populate @samp{$(LIBOBJS)}.
6138 @acindex AC_LIBSOURCE
6140 Using these variables is very similar to doing conditional compilation
6141 using @code{AC_SUBST} variables, as described in @ref{Conditional
6142 Sources}. That is, when building a program, @samp{$(LIBOBJS)} and
6143 @samp{$(ALLOCA)} should be added to the associated @samp{*_LDADD}
6144 variable, or to the @samp{*_LIBADD} variable when building a library.
6145 However there is no need to list the corresponding sources in
6146 @samp{EXTRA_*_SOURCES} nor to define @samp{*_DEPENDENCIES}. Automake
6147 automatically adds @samp{$(LIBOBJS)} and @samp{$(ALLOCA)} to the
6148 dependencies, and it will discover the list of corresponding source
6149 files automatically (by tracing the invocations of the
6150 @code{AC_LIBSOURCE} Autoconf macros). If you have already defined
6151 @samp{*_DEPENDENCIES} explicitly for an unrelated reason, then you
6152 either need to add these variables manually, or use
6153 @samp{EXTRA_*_DEPENDENCIES} instead of @samp{*_DEPENDENCIES}.
6155 These variables are usually used to build a portability library that
6156 is linked with all the programs of the project. We now review a
6157 sample setup. First, @file{configure.ac} contains some checks that
6158 affect either @code{LIBOBJS} or @code{ALLOCA}.
6163 AC_CONFIG_LIBOBJ_DIR([lib])
6165 AC_FUNC_MALLOC dnl May add malloc.$(OBJEXT) to LIBOBJS
6166 AC_FUNC_MEMCMP dnl May add memcmp.$(OBJEXT) to LIBOBJS
6167 AC_REPLACE_FUNCS([strdup]) dnl May add strdup.$(OBJEXT) to LIBOBJS
6168 AC_FUNC_ALLOCA dnl May add alloca.$(OBJEXT) to ALLOCA
6177 @acindex AC_CONFIG_LIBOBJ_DIR
6179 The @code{AC_CONFIG_LIBOBJ_DIR} tells Autoconf that the source files
6180 of these object files are to be found in the @file{lib/} directory.
6181 Automake can also use this information, otherwise it expects the
6182 source files are to be in the directory where the @samp{$(LIBOBJS)}
6183 and @samp{$(ALLOCA)} variables are used.
6185 The @file{lib/} directory should therefore contain @file{malloc.c},
6186 @file{memcmp.c}, @file{strdup.c}, @file{alloca.c}. Here is its
6192 noinst_LIBRARIES = libcompat.a
6193 libcompat_a_SOURCES =
6194 libcompat_a_LIBADD = $(LIBOBJS) $(ALLOCA)
6197 The library can have any name, of course, and anyway it is not going
6198 to be installed: it just holds the replacement versions of the missing
6199 or broken functions so we can later link them in. Many projects
6200 also include extra functions, specific to the project, in that
6201 library: they are simply added on the @code{_SOURCES} line.
6203 @cindex Empty libraries and @samp{$(LIBOBJS)}
6204 @cindex @samp{$(LIBOBJS)} and empty libraries
6205 There is a small trap here, though: @samp{$(LIBOBJS)} and
6206 @samp{$(ALLOCA)} might be empty, and building an empty library is not
6207 portable. You should ensure that there is always something to put in
6208 @file{libcompat.a}. Most projects will also add some utility
6209 functions in that directory, and list them in
6210 @code{libcompat_a_SOURCES}, so in practice @file{libcompat.a} cannot
6213 Finally here is how this library could be used from the @file{src/}
6219 # Link all programs in this directory with libcompat.a
6220 LDADD = ../lib/libcompat.a
6222 bin_PROGRAMS = tool1 tool2 @dots{}
6223 tool1_SOURCES = @dots{}
6224 tool2_SOURCES = @dots{}
6227 When option @option{subdir-objects} is not used, as in the above
6228 example, the variables @samp{$(LIBOBJS)} or @samp{$(ALLOCA)} can only
6229 be used in the directory where their sources lie. E.g., here it would
6230 be wrong to use @samp{$(LIBOBJS)} or @samp{$(ALLOCA)} in
6231 @file{src/Makefile.am}. However if both @option{subdir-objects} and
6232 @code{AC_CONFIG_LIBOBJ_DIR} are used, it is OK to use these variables
6233 in other directories. For instance @file{src/Makefile.am} could be
6239 AUTOMAKE_OPTIONS = subdir-objects
6240 LDADD = $(LIBOBJS) $(ALLOCA)
6242 bin_PROGRAMS = tool1 tool2 @dots{}
6243 tool1_SOURCES = @dots{}
6244 tool2_SOURCES = @dots{}
6247 Because @samp{$(LIBOBJS)} and @samp{$(ALLOCA)} contain object
6248 file names that end with @samp{.$(OBJEXT)}, they are not suitable for
6249 Libtool libraries (where the expected object extension is @file{.lo}):
6250 @code{LTLIBOBJS} and @code{LTALLOCA} should be used instead.
6252 @code{LTLIBOBJS} is defined automatically by Autoconf and should not
6253 be defined by hand (as in the past), however at the time of writing
6254 @code{LTALLOCA} still needs to be defined from @code{ALLOCA} manually.
6255 @xref{AC_LIBOBJ vs LIBOBJS, , @code{AC_LIBOBJ} vs.@: @code{LIBOBJS},
6256 autoconf, The Autoconf Manual}.
6259 @node Program Variables
6260 @section Variables used when building a program
6262 Occasionally it is useful to know which @file{Makefile} variables
6263 Automake uses for compilations, and in which order (@pxref{Flag
6264 Variables Ordering}); for instance, you might need to do your own
6265 compilation in some special cases.
6267 Some variables are inherited from Autoconf; these are @code{CC},
6268 @code{CFLAGS}, @code{CPPFLAGS}, @code{DEFS}, @code{LDFLAGS}, and
6277 There are some additional variables that Automake defines on its own:
6281 The contents of this variable are passed to every compilation that invokes
6282 the C preprocessor; it is a list of arguments to the preprocessor. For
6283 instance, @option{-I} and @option{-D} options should be listed here.
6285 Automake already provides some @option{-I} options automatically, in a
6286 separate variable that is also passed to every compilation that invokes
6287 the C preprocessor. In particular it generates @samp{-I.},
6288 @samp{-I$(srcdir)}, and a @option{-I} pointing to the directory holding
6289 @file{config.h} (if you've used @code{AC_CONFIG_HEADERS}). You can
6290 disable the default @option{-I} options using the @option{nostdinc}
6293 When a file to be included is generated during the build and not part
6294 of a distribution tarball, its location is under @code{$(builddir)},
6295 not under @code{$(srcdir)}. This matters especially for packages that
6296 use header files placed in sub-directories and want to allow builds
6297 outside the source tree (@pxref{VPATH Builds}). In that case we
6298 recommend using a pair of @option{-I} options, such as, e.g.,
6299 @samp{-Isome/subdir -I$(srcdir)/some/subdir} or
6300 @samp{-I$(top_builddir)/some/subdir -I$(top_srcdir)/some/subdir}.
6301 Note that the reference to the build tree should come before the
6302 reference to the source tree, so that accidentally leftover generated
6303 files in the source directory are ignored.
6305 @code{AM_CPPFLAGS} is ignored in preference to a per-executable (or
6306 per-library) @code{_CPPFLAGS} variable if it is defined.
6309 This does the same job as @code{AM_CPPFLAGS} (or any per-target
6310 @code{_CPPFLAGS} variable if it is used). It is an older name for the
6311 same functionality. This variable is deprecated; we suggest using
6312 @code{AM_CPPFLAGS} and per-target @code{_CPPFLAGS} instead.
6315 This is the variable the @file{Makefile.am} author can use to pass
6316 in additional C compiler flags. In some situations, this is
6317 not used, in preference to the per-executable (or per-library)
6321 This is the command used to compile a C source file. The file name is
6322 appended to form the complete command line.
6325 This is the variable the @file{Makefile.am} author can use to pass
6326 in additional linker flags. In some situations, this is not used, in
6327 preference to the per-executable (or per-library) @code{_LDFLAGS}.
6330 This is the command used to link a C program. It already includes
6331 @samp{-o $@@} and the usual variable references (for instance,
6332 @code{CFLAGS}); it takes as ``arguments'' the names of the object
6333 files and libraries to link in. This variable is not used when the
6334 linker is overridden with a per-target @code{_LINK} variable or
6335 per-target flags cause Automake to define such a @code{_LINK}
6341 @section Yacc and Lex support
6343 Automake has somewhat idiosyncratic support for Yacc and Lex.
6345 Automake assumes that the @file{.c} file generated by @command{yacc}
6346 or @command{lex} should be named using the basename of the input
6347 file. That is, for a Yacc source file @file{foo.y}, Automake will
6348 cause the intermediate file to be named @file{foo.c} (as opposed to
6349 @file{y.tab.c}, which is more traditional).
6351 The extension of a Yacc source file is used to determine the extension
6352 of the resulting C or C++ source and header files. Be aware that header
6353 files are generated only when the option @option{-d} is given to Yacc; see
6354 below for more information about this flag, and how to specify it.
6355 Files with the extension @file{.y} will thus be turned into @file{.c}
6356 sources and @file{.h} headers; likewise, @file{.yy} will become
6357 @file{.cc} and @file{.hh}, @file{.y++} will become @file{c++} and
6358 @file{h++}, @file{.yxx} will become @file{.cxx} and @file{.hxx},
6359 and @file{.ypp} will become @file{.cpp} and @file{.hpp}.
6361 Similarly, Lex source files can be used to generate C or C++; the
6362 extensions @file{.l}, @file{.ll}, @file{.l++}, @file{.lxx}, and
6363 @file{.lpp} are recognized.
6365 You should never explicitly mention the intermediate (C or C++) file
6366 in any @code{SOURCES} variable (except @code{BUILT_SOURCES}, see below);
6367 only list the source file.
6369 The intermediate files generated by @command{yacc} (or @command{lex})
6370 will be included in any distribution that is made. That way the user
6371 doesn't need to have @command{yacc} or @command{lex}.
6373 If a Yacc source file is seen, then your @file{configure.ac} must
6374 define the variable @code{YACC}. This is most easily done by invoking
6375 the macro @code{AC_PROG_YACC} (@pxref{Particular Programs, ,
6376 Particular Program Checks, autoconf, The Autoconf Manual}).
6380 When @code{yacc} is invoked, it is passed @code{AM_YFLAGS} and
6381 @code{YFLAGS}. The latter is a user variable and the former is
6382 intended for the @file{Makefile.am} author.
6384 @code{AM_YFLAGS} is usually used to pass the @option{-d} option to
6385 @command{yacc}. Automake knows what this means and will automatically
6386 adjust its rules to update and distribute the header file built by
6387 @samp{yacc -d}. Caveat: @command{automake} recognizes @option{-d} in
6388 @code{AM_YFLAGS} only if it is not clustered with other options; for
6389 example, it won't be recognized if @code{AM_YFLAGS} is @option{-dt},
6390 but it will be if @code{AM_YFLAGS} is @option{-d -t} or @option{-t
6393 What Automake cannot guess, though, is where this header will be used:
6394 it is up to you to ensure the header gets built before it is first
6395 used. Typically this is necessary in order for dependency tracking to
6396 work when the header is included by another file. The common solution
6397 is listing the header file, and the corresponding C file, in
6398 @code{BUILT_SOURCES} (@pxref{Sources}) as follows.
6401 BUILT_SOURCES = parser.h parser.c
6404 foo_SOURCES = @dots{} parser.y @dots{}
6407 If a Lex source file is seen, then your @file{configure.ac} must
6408 define the variable @code{LEX}. You can use @code{AC_PROG_LEX} to do
6409 this (@pxref{Particular Programs, , Particular Program Checks,
6410 autoconf, The Autoconf Manual}), but using the @code{AM_PROG_LEX}
6411 macro (@pxref{Macros}) is recommended.
6415 When @command{lex} is invoked, it is passed @code{AM_LFLAGS} and
6416 @code{LFLAGS}. The latter is a user variable and the former is
6417 intended for the @file{Makefile.am} author.
6419 When @code{AM_MAINTAINER_MODE} (@pxref{maintainer-mode}) is in effect,
6420 the rebuild rules for distributed Yacc and Lex sources are only used
6421 when @code{maintainer-mode} is enabled, or when the files have been
6424 @cindex @command{ylwrap}
6425 @cindex @command{yacc}, multiple parsers
6426 @cindex Multiple @command{yacc} parsers
6427 @cindex Multiple @command{lex} lexers
6428 @cindex @command{lex}, multiple lexers
6430 When Yacc or Lex sources are used, @code{automake -a} automatically
6431 installs an auxiliary program called @command{ylwrap} in your package
6432 (@pxref{Auxiliary Programs}). This program is used by the build rules
6433 to rename the output of these tools, and makes it possible to include
6434 multiple @command{yacc} (or @command{lex}) source files in a single
6435 directory. This is necessary because Yacc's output file name is
6436 fixed, and a parallel make could invoke more than one instance of
6437 @command{yacc} simultaneously.
6440 * Linking Multiple Yacc Parsers::
6443 @node Linking Multiple Yacc Parsers
6444 @subsection Linking Multiple Yacc Parsers
6446 @cindex Linking multiple @command{yacc} parsers
6448 For @command{yacc}, simply managing locking as with @code{ylwrap} is
6449 insufficient. The output of @command{yacc} always uses the same
6450 symbol names internally, so it isn't possible to link two
6451 @command{yacc} parsers into the same executable.
6453 We recommend using the following renaming hack used in @command{gdb}:
6455 #define yymaxdepth c_maxdepth
6456 #define yyparse c_parse
6458 #define yyerror c_error
6459 #define yylval c_lval
6460 #define yychar c_char
6461 #define yydebug c_debug
6462 #define yypact c_pact
6469 #define yyexca c_exca
6470 #define yyerrflag c_errflag
6471 #define yynerrs c_nerrs
6475 #define yy_yys c_yys
6476 #define yystate c_state
6479 #define yy_yyv c_yyv
6481 #define yylloc c_lloc
6482 #define yyreds c_reds
6483 #define yytoks c_toks
6484 #define yylhs c_yylhs
6485 #define yylen c_yylen
6486 #define yydefred c_yydefred
6487 #define yydgoto c_yydgoto
6488 #define yysindex c_yysindex
6489 #define yyrindex c_yyrindex
6490 #define yygindex c_yygindex
6491 #define yytable c_yytable
6492 #define yycheck c_yycheck
6493 #define yyname c_yyname
6494 #define yyrule c_yyrule
6497 For each define, replace the @samp{c_} prefix with whatever you like.
6498 These defines work for @command{bison}, @command{byacc}, and
6499 traditional @code{yacc}s. If you find a parser generator that uses a
6500 symbol not covered here, please report the new name so it can be added
6505 @section C++ Support
6508 @cindex Support for C++
6510 Automake includes full support for C++.
6512 Any package including C++ code must define the output variable
6513 @code{CXX} in @file{configure.ac}; the simplest way to do this is to use
6514 the @code{AC_PROG_CXX} macro (@pxref{Particular Programs, , Particular
6515 Program Checks, autoconf, The Autoconf Manual}).
6517 A few additional variables are defined when a C++ source file is seen:
6521 The name of the C++ compiler.
6524 Any flags to pass to the C++ compiler.
6527 The maintainer's variant of @code{CXXFLAGS}.
6530 The command used to compile a C++ source file. The file name is
6531 appended to form the complete command line.
6534 The command used to link a C++ program.
6538 @node Objective C Support
6539 @section Objective C Support
6541 @cindex Objective C support
6542 @cindex Support for Objective C
6544 Automake includes some support for Objective C.
6546 Any package including Objective C code must define the output variable
6547 @code{OBJC} in @file{configure.ac}; the simplest way to do this is to use
6548 the @code{AC_PROG_OBJC} macro (@pxref{Particular Programs, , Particular
6549 Program Checks, autoconf, The Autoconf Manual}).
6551 A few additional variables are defined when an Objective C source file
6556 The name of the Objective C compiler.
6559 Any flags to pass to the Objective C compiler.
6562 The maintainer's variant of @code{OBJCFLAGS}.
6565 The command used to compile an Objective C source file. The file name
6566 is appended to form the complete command line.
6569 The command used to link an Objective C program.
6573 @node Objective C++ Support
6574 @section Objective C++ Support
6576 @cindex Objective C++ support
6577 @cindex Support for Objective C++
6579 Automake includes some support for Objective C++.
6581 Any package including Objective C++ code must define the output variable
6582 @code{OBJCXX} in @file{configure.ac}; the simplest way to do this is to use
6583 the @code{AC_PROG_OBJCXX} macro (@pxref{Particular Programs, , Particular
6584 Program Checks, autoconf, The Autoconf Manual}).
6586 A few additional variables are defined when an Objective C++ source file
6591 The name of the Objective C++ compiler.
6594 Any flags to pass to the Objective C++ compiler.
6596 @item AM_OBJCXXFLAGS
6597 The maintainer's variant of @code{OBJCXXFLAGS}.
6600 The command used to compile an Objective C++ source file. The file
6601 name is appended to form the complete command line.
6604 The command used to link an Objective C++ program.
6608 @node Unified Parallel C Support
6609 @section Unified Parallel C Support
6611 @cindex Unified Parallel C support
6612 @cindex Support for Unified Parallel C
6614 Automake includes some support for Unified Parallel C.
6616 Any package including Unified Parallel C code must define the output
6617 variable @code{UPC} in @file{configure.ac}; the simplest way to do
6618 this is to use the @code{AM_PROG_UPC} macro (@pxref{Public Macros}).
6620 A few additional variables are defined when a Unified Parallel C
6621 source file is seen:
6625 The name of the Unified Parallel C compiler.
6628 Any flags to pass to the Unified Parallel C compiler.
6631 The maintainer's variant of @code{UPCFLAGS}.
6634 The command used to compile a Unified Parallel C source file. The
6635 file name is appended to form the complete command line.
6638 The command used to link a Unified Parallel C program.
6642 @node Assembly Support
6643 @section Assembly Support
6645 Automake includes some support for assembly code. There are two forms
6646 of assembler files: normal (@file{*.s}) and preprocessed by @code{CPP}
6647 (@file{*.S} or @file{*.sx}).
6652 @vindex AM_CCASFLAGS
6654 The variable @code{CCAS} holds the name of the compiler used to build
6655 assembly code. This compiler must work a bit like a C compiler; in
6656 particular it must accept @option{-c} and @option{-o}. The values of
6657 @code{CCASFLAGS} and @code{AM_CCASFLAGS} (or its per-target
6658 definition) is passed to the compilation. For preprocessed files,
6659 @code{DEFS}, @code{DEFAULT_INCLUDES}, @code{INCLUDES}, @code{CPPFLAGS}
6660 and @code{AM_CPPFLAGS} are also used.
6662 The autoconf macro @code{AM_PROG_AS} will define @code{CCAS} and
6663 @code{CCASFLAGS} for you (unless they are already set, it simply sets
6664 @code{CCAS} to the C compiler and @code{CCASFLAGS} to the C compiler
6665 flags), but you are free to define these variables by other means.
6667 Only the suffixes @file{.s}, @file{.S}, and @file{.sx} are recognized by
6668 @command{automake} as being files containing assembly code.
6671 @node Fortran 77 Support
6672 @comment node-name, next, previous, up
6673 @section Fortran 77 Support
6675 @cindex Fortran 77 support
6676 @cindex Support for Fortran 77
6678 Automake includes full support for Fortran 77.
6680 Any package including Fortran 77 code must define the output variable
6681 @code{F77} in @file{configure.ac}; the simplest way to do this is to use
6682 the @code{AC_PROG_F77} macro (@pxref{Particular Programs, , Particular
6683 Program Checks, autoconf, The Autoconf Manual}).
6685 A few additional variables are defined when a Fortran 77 source file is
6691 The name of the Fortran 77 compiler.
6694 Any flags to pass to the Fortran 77 compiler.
6697 The maintainer's variant of @code{FFLAGS}.
6700 Any flags to pass to the Ratfor compiler.
6703 The maintainer's variant of @code{RFLAGS}.
6706 The command used to compile a Fortran 77 source file. The file name
6707 is appended to form the complete command line.
6710 The command used to link a pure Fortran 77 program or shared library.
6713 Automake can handle preprocessing Fortran 77 and Ratfor source files in
6714 addition to compiling them@footnote{Much, if not most, of the
6715 information in the following sections pertaining to preprocessing
6716 Fortran 77 programs was taken almost verbatim from @ref{Catalogue of
6717 Rules, , Catalogue of Rules, make, The GNU Make Manual}.}. Automake
6718 also contains some support for creating programs and shared libraries
6719 that are a mixture of Fortran 77 and other languages (@pxref{Mixing
6720 Fortran 77 With C and C++}).
6722 These issues are covered in the following sections.
6725 * Preprocessing Fortran 77:: Preprocessing Fortran 77 sources
6726 * Compiling Fortran 77 Files:: Compiling Fortran 77 sources
6727 * Mixing Fortran 77 With C and C++:: Mixing Fortran 77 With C and C++
6731 @node Preprocessing Fortran 77
6732 @comment node-name, next, previous, up
6733 @subsection Preprocessing Fortran 77
6735 @cindex Preprocessing Fortran 77
6736 @cindex Fortran 77, Preprocessing
6737 @cindex Ratfor programs
6739 @file{N.f} is made automatically from @file{N.F} or @file{N.r}. This
6740 rule runs just the preprocessor to convert a preprocessable Fortran 77
6741 or Ratfor source file into a strict Fortran 77 source file. The precise
6742 command used is as follows:
6747 @code{$(F77) -F $(DEFS) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS)@*
6748 $(AM_FFLAGS) $(FFLAGS)}
6751 @code{$(F77) -F $(AM_FFLAGS) $(FFLAGS) $(AM_RFLAGS) $(RFLAGS)}
6756 @node Compiling Fortran 77 Files
6757 @comment node-name, next, previous, up
6758 @subsection Compiling Fortran 77 Files
6760 @file{N.o} is made automatically from @file{N.f}, @file{N.F} or
6761 @file{N.r} by running the Fortran 77 compiler. The precise command used
6767 @code{$(F77) -c $(AM_FFLAGS) $(FFLAGS)}
6770 @code{$(F77) -c $(DEFS) $(INCLUDES) $(AM_CPPFLAGS) $(CPPFLAGS)@*
6771 $(AM_FFLAGS) $(FFLAGS)}
6774 @code{$(F77) -c $(AM_FFLAGS) $(FFLAGS) $(AM_RFLAGS) $(RFLAGS)}
6779 @node Mixing Fortran 77 With C and C++
6780 @comment node-name, next, previous, up
6781 @subsection Mixing Fortran 77 With C and C++
6783 @cindex Fortran 77, mixing with C and C++
6784 @cindex Mixing Fortran 77 with C and C++
6785 @cindex Linking Fortran 77 with C and C++
6787 @cindex Mixing Fortran 77 with C and/or C++
6789 Automake currently provides @emph{limited} support for creating programs
6790 and shared libraries that are a mixture of Fortran 77 and C and/or C++.
6791 However, there are many other issues related to mixing Fortran 77 with
6792 other languages that are @emph{not} (currently) handled by Automake, but
6793 that are handled by other packages@footnote{For example,
6794 @uref{https://www-zeus.desy.de/~burow/cfortran/, the cfortran package}
6795 addresses all of these inter-language issues, and runs under nearly all
6796 Fortran 77, C and C++ compilers on nearly all platforms. However,
6797 @command{cfortran} is not yet Free Software, but it will be in the next
6800 Automake can help in two ways:
6804 Automatic selection of the linker depending on which combinations of
6808 Automatic selection of the appropriate linker flags (e.g., @option{-L} and
6809 @option{-l}) to pass to the automatically selected linker in order to link
6810 in the appropriate Fortran 77 intrinsic and run-time libraries.
6812 @cindex @code{FLIBS}, defined
6814 These extra Fortran 77 linker flags are supplied in the output variable
6815 @code{FLIBS} by the @code{AC_F77_LIBRARY_LDFLAGS} Autoconf macro.
6816 @xref{Fortran Compiler, , Fortran Compiler Characteristics, autoconf,
6817 The Autoconf Manual}.
6820 If Automake detects that a program or shared library (as mentioned in
6821 some @code{_PROGRAMS} or @code{_LTLIBRARIES} primary) contains source
6822 code that is a mixture of Fortran 77 and C and/or C++, then it requires
6823 that the macro @code{AC_F77_LIBRARY_LDFLAGS} be called in
6824 @file{configure.ac}, and that either @code{$(FLIBS)}
6825 appear in the appropriate @code{_LDADD} (for programs) or @code{_LIBADD}
6826 (for shared libraries) variables. It is the responsibility of the
6827 person writing the @file{Makefile.am} to make sure that @samp{$(FLIBS)}
6828 appears in the appropriate @code{_LDADD} or
6829 @code{_LIBADD} variable.
6831 @cindex Mixed language example
6832 @cindex Example, mixed language
6834 For example, consider the following @file{Makefile.am}:
6838 foo_SOURCES = main.cc foo.f
6839 foo_LDADD = libfoo.la $(FLIBS)
6841 pkglib_LTLIBRARIES = libfoo.la
6842 libfoo_la_SOURCES = bar.f baz.c zardoz.cc
6843 libfoo_la_LIBADD = $(FLIBS)
6846 In this case, Automake will insist that @code{AC_F77_LIBRARY_LDFLAGS}
6847 is mentioned in @file{configure.ac}. Also, if @samp{$(FLIBS)} hadn't
6848 been mentioned in @code{foo_LDADD} and @code{libfoo_la_LIBADD}, then
6849 Automake would have issued a warning.
6852 * How the Linker is Chosen:: Automatic linker selection
6855 @node How the Linker is Chosen
6856 @comment node-name, next, previous, up
6857 @subsubsection How the Linker is Chosen
6859 @cindex Automatic linker selection
6860 @cindex Selecting the linker automatically
6862 When a program or library mixes several languages, Automake chooses the
6863 linker according to the following priorities. (The names in
6864 parentheses are the variables containing the link command.)
6869 Native Java (@code{GCJLINK})
6872 Objective C++ (@code{OBJCXXLINK})
6875 C++ (@code{CXXLINK})
6878 Fortran 77 (@code{F77LINK})
6881 Fortran (@code{FCLINK})
6884 Objective C (@code{OBJCLINK})
6887 Unified Parallel C (@code{UPCLINK})
6893 For example, if Fortran 77, C and C++ source code is compiled
6894 into a program, then the C++ linker will be used. In this case, if the
6895 C or Fortran 77 linkers required any special libraries that weren't
6896 included by the C++ linker, then they must be manually added to an
6897 @code{_LDADD} or @code{_LIBADD} variable by the user writing the
6900 Automake only looks at the file names listed in @file{_SOURCES}
6901 variables to choose the linker, and defaults to the C linker.
6902 Sometimes this is inconvenient because you are linking against a
6903 library written in another language and would like to set the linker
6904 more appropriately. @xref{Libtool Convenience Libraries}, for a
6905 trick with @code{nodist_EXTRA_@dots{}_SOURCES}.
6907 A per-target @code{_LINK} variable will override the above selection.
6908 Per-target link flags will cause Automake to write a per-target
6909 @code{_LINK} variable according to the language chosen as above.
6912 @node Fortran 9x Support
6913 @comment node-name, next, previous, up
6914 @section Fortran 9x Support
6916 @cindex Fortran 9x support
6917 @cindex Support for Fortran 9x
6919 Automake includes support for Fortran 9x.
6921 Any package including Fortran 9x code must define the output variable
6922 @code{FC} in @file{configure.ac}; the simplest way to do this is to use
6923 the @code{AC_PROG_FC} macro (@pxref{Particular Programs, , Particular
6924 Program Checks, autoconf, The Autoconf Manual}).
6926 A few additional variables are defined when a Fortran 9x source file is
6932 The name of the Fortran 9x compiler.
6935 Any flags to pass to the Fortran 9x compiler.
6938 The maintainer's variant of @code{FCFLAGS}.
6941 The command used to compile a Fortran 9x source file. The file name
6942 is appended to form the complete command line.
6945 The command used to link a pure Fortran 9x program or shared library.
6949 * Compiling Fortran 9x Files:: Compiling Fortran 9x sources
6952 @node Compiling Fortran 9x Files
6953 @comment node-name, next, previous, up
6954 @subsection Compiling Fortran 9x Files
6956 @file{@var{file}.o} is made automatically from @file{@var{file}.f90},
6957 @file{@var{file}.f95}, @file{@var{file}.f03}, or @file{@var{file}.f08}
6958 by running the Fortran 9x compiler. The precise command used
6964 @code{$(FC) $(AM_FCFLAGS) $(FCFLAGS) -c $(FCFLAGS_f90) $<}
6967 @code{$(FC) $(AM_FCFLAGS) $(FCFLAGS) -c $(FCFLAGS_f95) $<}
6970 @code{$(FC) $(AM_FCFLAGS) $(FCFLAGS) -c $(FCFLAGS_f03) $<}
6973 @code{$(FC) $(AM_FCFLAGS) $(FCFLAGS) -c $(FCFLAGS_f08) $<}
6977 @node Java Support with gcj
6978 @comment node-name, next, previous, up
6979 @section Compiling Java sources using gcj
6981 @cindex Java support with gcj
6982 @cindex Support for Java with gcj
6983 @cindex Java to native code, compilation
6984 @cindex Compilation of Java to native code
6986 Automake includes support for natively compiled Java, using @command{gcj},
6987 the Java front end to the GNU Compiler Collection (rudimentary support
6988 for compiling Java to bytecode using the @command{javac} compiler is
6989 also present, @emph{albeit deprecated}; @pxref{Java}).
6991 Any package including Java code to be compiled must define the output
6992 variable @code{GCJ} in @file{configure.ac}; the variable @code{GCJFLAGS}
6993 must also be defined somehow (either in @file{configure.ac} or
6994 @file{Makefile.am}). The simplest way to do this is to use the
6995 @code{AM_PROG_GCJ} macro.
6999 By default, programs including Java source files are linked with
7002 As always, the contents of @code{AM_GCJFLAGS} are passed to every
7003 compilation invoking @command{gcj} (in its role as an ahead-of-time
7004 compiler, when invoking it to create @file{.class} files,
7005 @code{AM_JAVACFLAGS} is used instead). If it is necessary to pass
7006 options to @command{gcj} from @file{Makefile.am}, this variable, and not
7007 the user variable @code{GCJFLAGS}, should be used.
7011 @command{gcj} can be used to compile @file{.java}, @file{.class},
7012 @file{.zip}, or @file{.jar} files.
7014 When linking, @command{gcj} requires that the main class be specified
7015 using the @option{--main=} option. The easiest way to do this is to use
7016 the @code{_LDFLAGS} variable for the program.
7020 @comment node-name, next, previous, up
7021 @section Vala Support
7023 @cindex Vala Support
7024 @cindex Support for Vala
7026 Automake provides initial support for Vala
7027 (@uref{https://www.vala-project.org/}).
7028 This requires valac version 0.7.0 or later, and currently requires
7029 the user to use GNU @command{make}.
7032 foo_SOURCES = foo.vala bar.vala zardoz.c
7035 Any @file{.vala} file listed in a @code{_SOURCES} variable will be
7036 compiled into C code by the Vala compiler. The generated @file{.c} files
7037 are distributed. The end user does not need to have a Vala compiler installed.
7039 Automake ships with an Autoconf macro called @code{AM_PROG_VALAC}
7040 that will locate the Vala compiler and optionally check its version
7043 @defmac AM_PROG_VALAC (@ovar{minimum-version}, @ovar{action-if-found},
7044 @ovar{action-if-not-found})
7045 Search for a Vala compiler in @env{PATH}. If it is found, the variable
7046 @code{VALAC} is set to point to it (see below for more details). This
7047 macro takes three optional arguments. The first argument, if present,
7048 is the minimum version of the Vala API required to compile this package.
7049 For Vala releases, this is the same as the major and minor release
7050 number; e.g., when @code{valac --version} reports @code{0.48.7},
7051 @code{valac --api-version} reports @code{0.48}. If a compiler is found
7052 and satisfies @var{minimum-version}, then @var{action-if-found} is run
7053 (this defaults to do nothing). Otherwise, @var{action-if-not-found} is
7054 run. If @var{action-if-not-found} is not specified, the default value
7055 is to print a warning in case no compiler is found, or if a too-old
7056 version of the compiler is found.
7059 There are a few variables that are used when compiling Vala sources:
7063 Absolute path to the Vala compiler, or simply @samp{valac} if no
7064 suitable Vala compiler could be found at configure runtime.
7067 Additional arguments for the Vala compiler.
7070 The maintainer's variant of @code{VALAFLAGS}.
7073 lib_LTLIBRARIES = libfoo.la
7074 libfoo_la_SOURCES = foo.vala
7078 Note that currently, you cannot use per-target @code{*_VALAFLAGS}
7079 (@pxref{Renamed Objects}) to produce different C files from one Vala
7083 @node Support for Other Languages
7084 @comment node-name, next, previous, up
7085 @section Support for Other Languages
7087 Automake currently only includes full support for C, C++ (@pxref{C++
7088 Support}), Objective C (@pxref{Objective C Support}),
7089 Objective C++ (@pxref{Objective C++ Support}),
7091 (@pxref{Fortran 77 Support}), Fortran 9x (@pxref{Fortran 9x Support}),
7092 and Java (@pxref{Java Support with gcj}). There is only rudimentary
7093 support for other languages, support for which will be improved based
7096 Some limited support for adding your own languages is available via the
7097 suffix rule handling (@pxref{Suffixes}).
7100 @section Automatic dependency tracking
7102 As a developer it is often painful to continually update the
7103 @file{Makefile.am} whenever the include-file dependencies change in a
7104 project. Automake supplies a way to automatically track dependency
7105 changes (@pxref{Dependency Tracking}).
7107 @cindex Dependency tracking
7108 @cindex Automatic dependency tracking
7110 Automake always uses complete dependencies for a compilation,
7111 including system headers. Automake's model is that dependency
7112 computation should be a side effect of the build. To this end,
7113 dependencies are computed by running all compilations through a
7114 special wrapper program called @command{depcomp}. @command{depcomp}
7115 understands how to coax many different C and C++ compilers into
7116 generating dependency information in the format it requires.
7117 @samp{automake -a} will install @command{depcomp} into your source
7118 tree for you. If @command{depcomp} can't figure out how to properly
7119 invoke your compiler, dependency tracking will simply be disabled for
7122 @cindex @command{depcomp}
7124 Experience with earlier versions of Automake (@pxref{Dependency Tracking
7125 Evolution, , Dependency Tracking Evolution, automake-history, Brief History
7126 of Automake}) taught us that it is not reliable to generate dependencies
7127 only on the maintainer's system, as configurations vary too much. So
7128 instead Automake implements dependency tracking at build time.
7130 This automatic dependency tracking can be suppressed by putting
7131 @option{no-dependencies} in the variable @code{AUTOMAKE_OPTIONS}, or
7132 passing @option{no-dependencies} as an argument to @code{AM_INIT_AUTOMAKE}
7133 (this should be the preferred way). Or, you can invoke @command{automake}
7134 with the @option{-i} option. Dependency tracking is enabled by default.
7136 @vindex AUTOMAKE_OPTIONS
7137 @opindex no-dependencies
7139 @cindex Disabling dependency tracking
7140 @cindex Dependency tracking, disabling
7141 The person building your package also can choose to disable dependency
7142 tracking by configuring with @option{--disable-dependency-tracking}.
7144 @cindex Conditional for dependency tracking
7145 If, as the package maintainer, you wish to conditionalize your
7146 @code{Makefile.am} according to whether dependency tracking is
7147 enabled, the best way is to define your own conditional in
7148 @code{configure.ac} according to the shell variable
7149 @code{$enable_dependency_tracking} (all
7150 @code{--enable}/@code{--disable} options are available as shell
7151 variables; @pxref{Package Options, , , autoconf, The Autoconf Manual}):
7154 AM_CONDITIONAL([NO_DEP_TRACKING],
7155 [test x"$enable_dependency_tracking" = x"no"])
7158 And then in your @code{Makefile.am}:
7162 # stuff to do when dependency tracking is disabled
7164 # stuff to do when it's enabled
7169 @section Support for executable extensions
7171 @cindex Executable extension
7172 @cindex Extension, executable
7175 On some platforms, such as Windows, executables are expected to have an
7176 extension such as @file{.exe}. On these platforms, some compilers (GCC
7177 among them) will automatically generate @file{foo.exe} when asked to
7178 generate @file{foo}.
7180 Automake provides mostly-transparent support for this. Unfortunately
7181 @emph{mostly} doesn't yet mean @emph{fully}. Until the English
7182 dictionary is revised, you will have to assist Automake if your package
7183 must support those platforms.
7185 One thing you must be aware of is that, internally, Automake rewrites
7186 something like this:
7189 bin_PROGRAMS = liver
7196 bin_PROGRAMS = liver$(EXEEXT)
7199 The targets Automake generates are likewise given the @samp{$(EXEEXT)}
7202 The variables @code{TESTS} and @code{XFAIL_TESTS} (@pxref{Simple Tests})
7203 are also rewritten if they contain filenames that have been declared as
7204 programs in the same @file{Makefile}. (This is mostly useful when some
7205 programs from @code{check_PROGRAMS} are listed in @code{TESTS}.)
7207 However, Automake cannot apply this rewriting to @command{configure}
7208 substitutions. This means that if you are conditionally building a
7209 program using such a substitution, then your @file{configure.ac} must
7210 take care to add @samp{$(EXEEXT)} when constructing the output variable.
7212 Sometimes maintainers like to write an explicit link rule for their
7213 program. Without executable extension support, this is easy---you
7214 simply write a rule whose target is the name of the program. However,
7215 when executable extension support is enabled, you must instead add the
7216 @samp{$(EXEEXT)} suffix.
7218 This might be a nuisance for maintainers who know their package will
7219 never run on a platform that has
7220 executable extensions. For those maintainers, the @option{no-exeext}
7221 option (@pxref{Options}) will disable this feature. This works in a
7222 fairly ugly way; if @option{no-exeext} is seen, then the presence of a
7223 rule for a target named @code{foo} in @file{Makefile.am} will override
7224 an @command{automake}-generated rule for @samp{foo$(EXEEXT)}. Without
7225 the @option{no-exeext} option, this use will give a diagnostic.
7229 @chapter Other Derived Objects
7231 Automake can handle derived objects that are not C programs.
7232 Sometimes the support for building such objects must be explicitly
7233 supplied, but Automake can still automatically handle installation and
7237 * Scripts:: Executable scripts
7238 * Headers:: Header files
7239 * Data:: Architecture-independent data files
7240 * Sources:: Derived sources
7245 @section Executable Scripts
7247 @cindex @code{_SCRIPTS} primary, defined
7248 @cindex @code{SCRIPTS} primary, defined
7249 @cindex Primary variable, @code{SCRIPTS}
7251 @cindex Installing scripts
7253 It is possible to define and install programs that are scripts. Such
7254 programs are listed using the @code{SCRIPTS} primary name. When the
7255 script is distributed in its final, installable form, the
7256 @file{Makefile} usually looks as follows:
7260 # Install my_script in $(bindir) and distribute it.
7261 dist_bin_SCRIPTS = my_script
7264 Scripts are not distributed by default; as we have just seen, those
7265 that should be distributed can be specified using a @code{dist_}
7266 prefix as with other primaries.
7268 @cindex @code{SCRIPTS}, installation directories
7270 @vindex sbin_SCRIPTS
7271 @vindex libexec_SCRIPTS
7272 @vindex pkgdata_SCRIPTS
7273 @vindex pkglibexec_SCRIPTS
7274 @vindex noinst_SCRIPTS
7275 @vindex check_SCRIPTS
7277 Scripts can be installed in @code{bindir}, @code{sbindir},
7278 @code{libexecdir}, @code{pkglibexecdir}, or @code{pkgdatadir}.
7280 Scripts that need not be installed can be listed in
7281 @code{noinst_SCRIPTS}, and among them, those which are needed only by
7282 @samp{make check} should go in @code{check_SCRIPTS}.
7284 When a script needs to be built, the @file{Makefile.am} should include
7285 the appropriate rules. For instance the @command{automake} program
7286 itself is a Perl script that is generated from @file{automake.in}.
7287 Here is how this is handled:
7290 bin_SCRIPTS = automake
7291 CLEANFILES = $(bin_SCRIPTS)
7292 EXTRA_DIST = automake.in
7294 do_subst = sed -e 's,[@@]datadir[@@],$(datadir),g' \
7295 -e 's,[@@]PERL[@@],$(PERL),g' \
7296 -e 's,[@@]PACKAGE[@@],$(PACKAGE),g' \
7297 -e 's,[@@]VERSION[@@],$(VERSION),g' \
7300 automake: automake.in Makefile
7301 $(do_subst) < $(srcdir)/automake.in > automake
7305 Such scripts for which a build rule has been supplied need to be
7306 deleted explicitly using @code{CLEANFILES} (@pxref{Clean}), and their
7307 sources have to be distributed, usually with @code{EXTRA_DIST}
7308 (@pxref{Basics of Distribution}).
7310 Another common way to build scripts is to process them from
7311 @file{configure} with @code{AC_CONFIG_FILES}. In this situation
7312 Automake knows which files should be cleaned and distributed, and what
7313 the rebuild rules should look like.
7315 For instance if @file{configure.ac} contains
7318 AC_CONFIG_FILES([src/my_script], [chmod +x src/my_script])
7322 to build @file{src/my_script} from @file{src/my_script.in}, then a
7323 @file{src/Makefile.am} to install this script in @code{$(bindir)} can
7327 bin_SCRIPTS = my_script
7328 CLEANFILES = $(bin_SCRIPTS)
7332 There is no need for @code{EXTRA_DIST} or any build rule: Automake
7333 infers them from @code{AC_CONFIG_FILES} (@pxref{Requirements}).
7334 @code{CLEANFILES} is still useful, because by default Automake will
7335 clean targets of @code{AC_CONFIG_FILES} in @code{distclean}, not
7338 Although this looks simpler, building scripts this way has one
7339 drawback: directory variables such as @code{$(datadir)} are not fully
7340 expanded and may refer to other directory variables.
7343 @section Header files
7345 @cindex @code{_HEADERS} primary, defined
7346 @cindex @code{HEADERS} primary, defined
7347 @cindex Primary variable, @code{HEADERS}
7349 @vindex noinst_HEADERS
7350 @cindex @code{HEADERS}, installation directories
7351 @cindex Installing headers
7352 @vindex include_HEADERS
7353 @vindex oldinclude_HEADERS
7354 @vindex pkginclude_HEADERS
7357 Header files that must be installed are specified by the
7358 @code{HEADERS} family of variables. Headers can be installed in
7359 @code{includedir}, @code{oldincludedir}, @code{pkgincludedir} or any
7360 other directory you may have defined (@pxref{Uniform}). For instance,
7363 include_HEADERS = foo.h bar/bar.h
7367 will install the two files as @file{$(includedir)/foo.h} and
7368 @file{$(includedir)/bar.h}.
7370 The @code{nobase_} prefix is also supported:
7373 nobase_include_HEADERS = foo.h bar/bar.h
7377 will install the two files as @file{$(includedir)/foo.h} and
7378 @file{$(includedir)/bar/bar.h} (@pxref{Alternative}).
7380 @vindex noinst_HEADERS
7381 Usually, only header files that accompany installed libraries need to
7382 be installed. Headers used by programs or convenience libraries are
7383 not installed. The @code{noinst_HEADERS} variable can be used for
7384 such headers. However, when the header belongs to a single
7385 convenience library or program, we recommend listing it in the
7386 program's or library's @code{_SOURCES} variable (@pxref{Program
7387 Sources}) instead of in @code{noinst_HEADERS}. This is clearer for
7388 the @file{Makefile.am} reader. @code{noinst_HEADERS} would be the
7389 right variable to use in a directory containing only headers and no
7390 associated library or program.
7392 All header files must be listed somewhere; in a @code{_SOURCES}
7393 variable or in a @code{_HEADERS} variable. Missing ones will not
7394 appear in the distribution.
7396 For header files that are built and must not be distributed, use the
7397 @code{nodist_} prefix as in @code{nodist_include_HEADERS} or
7398 @code{nodist_prog_SOURCES}. If these generated headers are needed
7399 during the build, you must also ensure they exist before they are
7400 used (@pxref{Sources}).
7404 @section Architecture-independent data files
7406 @cindex @code{_DATA} primary, defined
7407 @cindex @code{DATA} primary, defined
7408 @cindex Primary variable, @code{DATA}
7411 Automake supports the installation of miscellaneous data files using the
7412 @code{DATA} family of variables.
7418 @vindex sysconf_DATA
7419 @vindex sharedstate_DATA
7420 @vindex localstate_DATA
7421 @vindex pkgdata_DATA
7423 Such data can be installed in the directories @code{datadir},
7424 @code{docdir}, @code{lispdir}, @code{sysconfdir}, @code{sharedstatedir},
7425 @code{localstatedir}, or @code{pkgdatadir}.
7427 By default, data files are @emph{not} included in a distribution. Of
7428 course, you can use the @code{dist_} prefix to change this on a
7431 Here is how Automake declares its auxiliary data files:
7434 dist_pkgdata_DATA = clean-kr.am clean.am @dots{}
7439 @section Built Sources
7441 Because Automake's automatic dependency tracking works as a side-effect
7442 of compilation (@pxref{Dependencies}) there is a bootstrap issue: a
7443 target should not be compiled before its dependencies are made, but
7444 these dependencies are unknown until the target is first compiled.
7446 Ordinarily this is not a problem, because dependencies are distributed
7447 sources: they preexist and do not need to be built. Suppose that
7448 @file{foo.c} includes @file{foo.h}. When it first compiles
7449 @file{foo.o}, @command{make} only knows that @file{foo.o} depends on
7450 @file{foo.c}. As a side-effect of this compilation @command{depcomp}
7451 records the @file{foo.h} dependency so that following invocations of
7452 @command{make} will honor it. In these conditions, it's clear there is
7453 no problem: either @file{foo.o} doesn't exist and has to be built
7454 (regardless of the dependencies), or accurate dependencies exist and
7455 they can be used to decide whether @file{foo.o} should be rebuilt.
7457 It's a different story if @file{foo.h} doesn't exist by the first
7458 @command{make} run. For instance, there might be a rule to build
7459 @file{foo.h}. This time @file{file.o}'s build will fail because the
7460 compiler can't find @file{foo.h}. @command{make} failed to trigger the
7461 rule to build @file{foo.h} first by lack of dependency information.
7463 @vindex BUILT_SOURCES
7464 @cindex @code{BUILT_SOURCES}, defined
7466 The @code{BUILT_SOURCES} variable is a workaround for this problem. A
7467 source file listed in @code{BUILT_SOURCES} is made when @samp{make
7468 all}, @samp{make check}, @samp{make install}, @samp{make install-exec}
7469 (or @code{make dist}) is run, before other targets are processed.
7470 However, such a source file is not @emph{compiled} unless explicitly
7471 requested by mentioning it in some other @code{_SOURCES} variable.
7473 So, to conclude our introductory example, we could use
7474 @samp{BUILT_SOURCES = foo.h} to ensure @file{foo.h} gets built before
7475 any other target (including @file{foo.o}) during @samp{make all} or
7478 @code{BUILT_SOURCES} is a bit of a misnomer, as any file which must be
7479 created early in the build process can be listed in this variable.
7480 Moreover, all built sources do not necessarily have to be listed in
7481 @code{BUILT_SOURCES}. For instance, a generated @file{.c} file
7482 doesn't need to appear in @code{BUILT_SOURCES} (unless it is included
7483 by another source), because it's a known dependency of the associated
7486 To emphasize, @code{BUILT_SOURCES} is honored only by @samp{make all},
7487 @samp{make check}, @samp{make install}, and @code{make install-exec}
7488 (and @samp{make dist}). This means you cannot build an arbitrary
7489 target (e.g., @samp{make foo}) in a clean tree if it depends on a
7490 built source. However it will succeed if you have run @samp{make all}
7491 earlier, because accurate dependencies are already available.
7493 The next section illustrates and discusses the handling of built sources
7497 * Built Sources Example:: Several ways to handle built sources.
7500 @node Built Sources Example
7501 @subsection Built Sources Example
7503 Suppose that @file{foo.c} includes @file{bindir.h}, which is
7504 installation-dependent and not distributed: it needs to be built. Here
7505 @file{bindir.h} defines the preprocessor macro @code{bindir} to the
7506 value of the @command{make} variable @code{bindir} (inherited from
7509 We suggest several implementations below. It's not meant to be an
7510 exhaustive listing of all ways to handle built sources, but it will give
7511 you a few ideas if you encounter this issue.
7513 @subsubheading First Try
7515 This first implementation will illustrate the bootstrap issue mentioned
7516 in the previous section (@pxref{Sources}).
7518 Here is a tentative @file{Makefile.am}.
7524 nodist_foo_SOURCES = bindir.h
7525 CLEANFILES = bindir.h
7527 echo '#define bindir "$(bindir)"' >$@@
7530 This setup doesn't work, because Automake doesn't know that @file{foo.c}
7531 includes @file{bindir.h}. Remember, automatic dependency tracking works
7532 as a side-effect of compilation, so the dependencies of @file{foo.o} will
7533 be known only after @file{foo.o} has been compiled (@pxref{Dependencies}).
7534 The symptom is as follows.
7538 source='foo.c' object='foo.o' libtool=no \
7539 depfile='.deps/foo.Po' tmpdepfile='.deps/foo.TPo' \
7540 depmode=gcc /bin/sh ./depcomp \
7541 gcc -I. -I. -g -O2 -c `test -f 'foo.c' || echo './'`foo.c
7542 foo.c:2: bindir.h: No such file or directory
7543 make: *** [foo.o] Error 1
7546 In this example @file{bindir.h} is not distributed nor installed, and
7547 it is not even being built on-time. One may wonder if the
7548 @samp{nodist_foo_SOURCES = bindir.h} line has any use at all. This
7549 line simply states that @file{bindir.h} is a source of @code{foo}, so
7550 for instance, it should be inspected while generating tags
7551 (@pxref{Tags}). In other words, it does not help our present problem,
7552 and the build would fail identically without it.
7554 @subsubheading Using @code{BUILT_SOURCES}
7556 A solution is to require @file{bindir.h} to be built before anything
7557 else. This is what @code{BUILT_SOURCES} is meant for (@pxref{Sources}).
7562 nodist_foo_SOURCES = bindir.h
7563 BUILT_SOURCES = bindir.h
7564 CLEANFILES = bindir.h
7566 echo '#define bindir "$(bindir)"' >$@@
7569 See how @file{bindir.h} gets built first:
7573 echo '#define bindir "/usr/local/bin"' >bindir.h
7575 make[1]: Entering directory `/home/adl/tmp'
7576 source='foo.c' object='foo.o' libtool=no \
7577 depfile='.deps/foo.Po' tmpdepfile='.deps/foo.TPo' \
7578 depmode=gcc /bin/sh ./depcomp \
7579 gcc -I. -I. -g -O2 -c `test -f 'foo.c' || echo './'`foo.c
7580 gcc -g -O2 -o foo foo.o
7581 make[1]: Leaving directory `/home/adl/tmp'
7584 However, as said earlier, @code{BUILT_SOURCES} applies only to the
7585 @code{all}, @code{check}, and @code{install} targets. It still fails
7586 if you try to run @samp{make foo} explicitly:
7590 test -z "bindir.h" || rm -f bindir.h
7591 test -z "foo" || rm -f foo
7593 % @kbd{: > .deps/foo.Po} # Suppress previously recorded dependencies
7595 source='foo.c' object='foo.o' libtool=no \
7596 depfile='.deps/foo.Po' tmpdepfile='.deps/foo.TPo' \
7597 depmode=gcc /bin/sh ./depcomp \
7598 gcc -I. -I. -g -O2 -c `test -f 'foo.c' || echo './'`foo.c
7599 foo.c:2: bindir.h: No such file or directory
7600 make: *** [foo.o] Error 1
7603 @subsubheading Recording Dependencies manually
7605 Usually people are happy enough with @code{BUILT_SOURCES} because they
7606 never build targets such as @samp{make foo} before @samp{make all}, as
7607 in the previous example. However if this matters to you, you can
7608 avoid @code{BUILT_SOURCES} and record such dependencies explicitly in
7609 the @file{Makefile.am}.
7614 nodist_foo_SOURCES = bindir.h
7615 foo.$(OBJEXT): bindir.h
7616 CLEANFILES = bindir.h
7618 echo '#define bindir "$(bindir)"' >$@@
7621 You don't have to list @emph{all} the dependencies of @file{foo.o}
7622 explicitly, only those that might need to be built. If a dependency
7623 already exists, it will not hinder the first compilation and will be
7624 recorded by the normal dependency tracking code. (After this first
7625 compilation, the dependency tracking code will also have recorded the
7626 dependency between @file{foo.o} and @file{bindir.h}, so our explicit
7627 dependency is only useful to the first build.)
7629 Adding explicit dependencies like this can be a bit dangerous if you are
7630 not careful enough. This is due to the way Automake tries not to
7631 overwrite your rules (it assumes you know better than it).
7632 @samp{foo.$(OBJEXT): bindir.h} supersedes any rule Automake may want to
7633 output to build @samp{foo.$(OBJEXT)}. It happens to work in this case
7634 because Automake doesn't have to output any @samp{foo.$(OBJEXT):}
7635 target: it relies on a suffix rule instead (i.e., @samp{.c.$(OBJEXT):}).
7636 Always check the generated @file{Makefile.in} if you do this.
7638 @subsubheading Build @file{bindir.h} from @file{configure}
7640 It's possible to define this preprocessor macro from @file{configure},
7641 either in @file{config.h} (@pxref{Defining Directories, , Defining
7642 Directories, autoconf, The Autoconf Manual}), or by processing a
7643 @file{bindir.h.in} file using @code{AC_CONFIG_FILES}
7644 (@pxref{Configuration Actions, ,Configuration Actions, autoconf, The
7647 At this point it should be clear that building @file{bindir.h} from
7648 @file{configure} works well for this example. @file{bindir.h} will exist
7649 before you build any target, hence will not cause any dependency issue.
7651 The Makefile can be shrunk as follows. We do not even have to mention
7659 However, it's not always possible to build sources from
7660 @file{configure}, especially when these sources are generated by a tool
7661 that needs to be built first.
7663 @subsubheading Build @file{bindir.c}, not @file{bindir.h}.
7665 Another attractive idea is to define @code{bindir} as a variable or
7666 function exported from @file{bindir.o}, and build @file{bindir.c}
7667 instead of @file{bindir.h}.
7670 noinst_PROGRAMS = foo
7671 foo_SOURCES = foo.c bindir.h
7672 nodist_foo_SOURCES = bindir.c
7673 CLEANFILES = bindir.c
7675 echo 'const char bindir[] = "$(bindir)";' >$@@
7678 @file{bindir.h} contains just the variable's declaration and doesn't
7679 need to be built, so it won't cause any trouble. @file{bindir.o} is
7680 always dependent on @file{bindir.c}, so @file{bindir.c} will get built
7683 @subsubheading Which is best?
7685 There is no panacea, of course. Each solution has its merits and
7688 You cannot use @code{BUILT_SOURCES} if the ability to run @samp{make
7689 foo} on a clean tree is important to you.
7691 You won't add explicit dependencies if you are leery of overriding
7692 an Automake rule by mistake.
7694 Building files from @file{./configure} is not always possible, neither
7695 is converting @file{.h} files into @file{.c} files.
7698 @node Other GNU Tools
7699 @chapter Other GNU Tools
7701 Since Automake is primarily intended to generate @file{Makefile.in}s for
7702 use in GNU programs, it tries hard to interoperate with other GNU tools.
7705 * Emacs Lisp:: Emacs Lisp
7708 * Java:: Java bytecode compilation (deprecated)
7716 @cindex @code{_LISP} primary, defined
7717 @cindex @code{LISP} primary, defined
7718 @cindex Primary variable, @code{LISP}
7724 Automake provides some support for Emacs Lisp. The @code{LISP} primary
7725 is used to hold a list of @file{.el} files. Possible prefixes for this
7726 primary are @code{lisp_} and @code{noinst_}. Note that if
7727 @code{lisp_LISP} is defined, then @file{configure.ac} must run
7728 @code{AM_PATH_LISPDIR} (@pxref{Macros}).
7730 @vindex dist_lisp_LISP
7731 @vindex dist_noinst_LISP
7732 Lisp sources are not distributed by default. You can prefix the
7733 @code{LISP} primary with @code{dist_}, as in @code{dist_lisp_LISP} or
7734 @code{dist_noinst_LISP}, to indicate that these files should be
7737 Automake will byte-compile all Emacs Lisp source files using the Emacs
7738 found by @code{AM_PATH_LISPDIR}, if any was found. When performing such
7739 byte-compilation, the flags specified in the (developer-reserved)
7740 @code{AM_ELCFLAGS} and (user-reserved) @code{ELCFLAGS} make variables
7741 will be passed to the Emacs invocation.
7743 Byte-compiled Emacs Lisp files are not portable among all versions of
7744 Emacs, so it makes sense to turn this off if you expect sites to have
7745 more than one version of Emacs installed. Furthermore, many packages
7746 do not actually benefit from byte-compilation. Still, we recommend
7747 that you byte-compile your Emacs Lisp sources. It is probably better
7748 for sites with strange setups to cope for themselves than to make the
7749 installation less nice for everybody else.
7751 There are two ways to avoid byte-compiling. Historically, we have
7752 recommended the following construct.
7755 lisp_LISP = file1.el file2.el
7760 @code{ELCFILES} is an internal Automake variable that normally lists
7761 all @file{.elc} files that must be byte-compiled. Automake defines
7762 @code{ELCFILES} automatically from @code{lisp_LISP}. Emptying this
7763 variable explicitly prevents byte-compilation.
7765 Since Automake 1.8, we now recommend using @code{lisp_DATA} instead:
7767 @c Keep in sync with primary-prefix-couples-documented-valid.sh
7769 lisp_DATA = file1.el file2.el
7772 Note that these two constructs are not equivalent. @code{_LISP} will
7773 not install a file if Emacs is not installed, while @code{_DATA} will
7774 always install its files.
7779 @cindex GNU Gettext support
7780 @cindex Gettext support
7781 @cindex Support for GNU Gettext
7783 If @code{AM_GNU_GETTEXT} is seen in @file{configure.ac}, then Automake
7784 turns on support for GNU gettext, a message catalog system for
7785 internationalization
7786 (@pxref{Top, , Introduction, gettext, GNU gettext utilities}).
7788 The @code{gettext} support in Automake requires the addition of one or
7789 two subdirectories to the package: @file{po} and possibly also @file{intl}.
7790 The latter is needed if @code{AM_GNU_GETTEXT} is not invoked with the
7791 @samp{external} argument, or if @code{AM_GNU_GETTEXT_INTL_SUBDIR} is used.
7792 Automake ensures that these directories exist and are mentioned in
7798 Automake provides support for GNU Libtool (@pxref{Top, , Introduction,
7799 libtool, The Libtool Manual}) with the @code{LTLIBRARIES} primary.
7800 @xref{A Shared Library}.
7804 @section Java bytecode compilation (deprecated)
7806 @cindex @code{_JAVA} primary, defined
7807 @cindex @code{JAVA} primary, defined
7808 @cindex Primary variable, @code{JAVA}
7809 @cindex Java to bytecode, compilation
7810 @cindex Compilation of Java to bytecode
7812 Automake provides some minimal support for Java bytecode compilation with
7813 the @code{JAVA} primary (in addition to the support for compiling Java to
7814 native machine code; @pxref{Java Support with gcj}). Note however that
7815 @emph{the interface and most features described here are deprecated}.
7816 Future Automake releases will strive to provide a better and cleaner
7817 interface, which however @emph{won't be backward-compatible}; the present
7818 interface will probably be removed altogether some time after the
7819 introduction of the new interface (if that ever materializes). In any
7820 case, the current @code{JAVA} primary features are frozen and will no
7821 longer be developed, not even to take bug fixes.
7823 Any @file{.java} files listed in a @code{_JAVA} variable will be
7824 compiled with @code{JAVAC} at build time. By default, @file{.java}
7825 files are not included in the distribution; you should use the
7826 @code{dist_} prefix to distribute them.
7828 Here is a typical setup for distributing @file{.java} files and
7829 installing the @file{.class} files resulting from their compilation.
7831 @c Keep in sync with primary-prefix-couples-documented-valid.sh
7833 javadir = $(datadir)/java
7834 dist_java_JAVA = a.java b.java @dots{}
7837 @cindex @code{JAVA} restrictions
7838 @cindex Restrictions for @code{JAVA}
7840 Currently Automake enforces the restriction that only one @code{_JAVA}
7841 primary can be used in a given @file{Makefile.am}. The reason for this
7842 restriction is that, in general, it isn't possible to know which
7843 @file{.class} files were generated from which @file{.java} files, so
7844 it would be impossible to know which files to install where. For
7845 instance, a @file{.java} file can define multiple classes; the resulting
7846 @file{.class} file names cannot be predicted without parsing the
7849 There are a few variables that are used when compiling Java sources:
7853 The name of the Java compiler. This defaults to @samp{javac}.
7856 The flags to pass to the compiler. This is considered to be a user
7857 variable (@pxref{User Variables}).
7860 More flags to pass to the Java compiler. This, and not
7861 @code{JAVACFLAGS}, should be used when it is necessary to put Java
7862 compiler flags into @file{Makefile.am}.
7865 The value of this variable is passed to the @option{-d} option to
7866 @code{javac}. It defaults to @samp{$(top_builddir)}.
7869 This variable is a shell expression that is used to set the
7870 @env{CLASSPATH} environment variable on the @code{javac} command line.
7871 (In the future we will probably handle class path setting differently.)
7878 @cindex @code{_PYTHON} primary, defined
7879 @cindex @code{PYTHON} primary, defined
7880 @cindex Primary variable, @code{PYTHON}
7883 Automake provides support for Python compilation with the
7884 @code{PYTHON} primary. A typical setup is to call
7885 @code{AM_PATH_PYTHON} in @file{configure.ac} and use a line like this
7886 in @file{Makefile.am}:
7889 python_PYTHON = tree.py leave.py
7892 Python source files are included in the distribution by default;
7893 prepend @code{nodist_} (as in @code{nodist_python_PYTHON}) to omit
7896 @cindex @file{.pyc}, @file{.pyo} files
7897 At install time, any files listed in a @code{_PYTHON} variable will be
7898 byte-compiled with @command{py-compile}. @command{py-compile} creates
7899 both standard (@file{.pyc}) and optimized (@file{.pyo}) byte-compiled
7900 versions of the source files. Because byte-compilation occurs at
7901 install time, files listed in @code{noinst_PYTHON} will not be
7904 Automake ships with an Autoconf macro named @code{AM_PATH_PYTHON} that
7905 determines some Python-related directory variables (see below). If
7906 you have called @code{AM_PATH_PYTHON} from @file{configure.ac}, then
7907 you may use the variables
7908 @c Keep in sync with primary-prefix-couples-documented-valid.sh
7909 @code{python_PYTHON} and @code{pkgpython_PYTHON} to list Python source
7910 files in your @file{Makefile.am}, depending on whether you want your
7911 files installed in @code{pythondir} or @code{pkgpythondir},
7914 @defmac AM_PATH_PYTHON (@ovar{version}, @ovar{action-if-found},
7915 @ovar{action-if-not-found})
7917 Search for a Python interpreter on the system. This macro takes three
7918 optional arguments. The first argument, if present, is the minimum
7919 version of Python required for this package: @code{AM_PATH_PYTHON}
7920 will skip any Python interpreter that is older than @var{version}.
7921 If an interpreter is found and satisfies @var{version}, then
7922 @var{action-if-found} is run. Otherwise, @var{action-if-not-found} is
7925 If @var{action-if-not-found} is not specified, as in the following
7926 example, the default is to abort @command{configure}:
7929 AM_PATH_PYTHON([2.5])
7933 This is fine when Python is an absolute requirement for the package.
7934 If Python @geq{} 2.5 was only @emph{optional} for the package,
7935 @code{AM_PATH_PYTHON} could be called as follows.
7938 AM_PATH_PYTHON([2.5],, [:])
7941 If the @env{PYTHON} variable is set when @code{AM_PATH_PYTHON} is
7942 called, then that will be the only Python interpreter that is tried.
7944 @code{AM_PATH_PYTHON} creates the following output variables based on
7945 the Python installation found during configuration:
7950 The name of the Python executable, or @samp{:} if no suitable
7951 interpreter could be found.
7953 Assuming @var{action-if-not-found} is used (otherwise @file{./configure}
7954 will abort if Python is absent), the value of @code{PYTHON} can be used
7955 to set up a conditional in order to disable the relevant part of a build
7959 AM_PATH_PYTHON(,, [:])
7960 AM_CONDITIONAL([HAVE_PYTHON], [test "$PYTHON" != :])
7963 @item PYTHON_VERSION
7964 @vindex sys.version_info @r{Python variable}
7965 The Python version number, in the form @var{major}.@var{minor}
7966 (e.g., @samp{2.5}). This is set to be the value of
7967 @samp{'%u.%u' % sys.version_info[:2]}.
7970 @itemx PYTHON_EXEC_PREFIX
7971 @opindex --with-python-sys-prefix
7972 @opindex --with-python_prefix
7973 @opindex --with-python_exec_prefix
7974 @vindex sys.prefix @r{Python variable}
7975 @vindex sys.exec_prefix @r{Python variable}
7976 With no special options given, these have values @samp{$@{prefix@}}
7977 and @samp{$@{exec_prefix@}}, respectively (unexpanded; see below).
7979 The @file{configure} options @option{--with-python_prefix}
7980 and @option{--with-python_exec_prefix} set them to an explicit value.
7982 The @file{configure} option @option{--with-python-sys-prefix} set them
7983 to the values of Python's @samp{sys.prefix} and @samp{sys.exec_prefix}
7984 variables. These often differ from @samp{$@{prefix@}} and
7985 @samp{$@{exec_prefix@}}, e.g., on platforms such as Mac@tie{}OS@tie{}x
7986 (where Python is usually installed as a Framework).
7988 @item PYTHON_PLATFORM
7989 @vindex sys.platform @r{Python variable}
7990 The canonical name used by Python to describe the operating system, as
7991 given by @samp{sys.platform}. This value is sometimes needed when
7992 building Python extensions.
7995 @cindex @file{site-packages} Python directory
7996 @cindex @file{dist-packages} Python directory
7997 The subdirectory of the Python install tree in which to install Python
7998 scripts. By default this is, on all systems,
7999 @file{$PYTHON_PREFIX/lib/python@var{version}/site-packages}, where
8000 @code{$PYTHON_PREFIX} is described above, and @var{version} is the
8001 Python version. (For those knowledgeable about Python installation
8002 details: systems generally have their own Python installation scheme,
8003 such as @code{posix_local} on Debian and related (as of
8004 Python@tie{}3.10), which ends up using a directory named
8005 @file{dist-packages}; Automake uses the @code{posix_prefix} scheme and
8006 @file{site-packages}.)
8007 @c https://bugs.gnu.org/54412 et al.
8010 This is the directory under @code{pythondir} that is named after the
8011 package. That is, it is @samp{$(pythondir)/$(PACKAGE)}. It is provided
8015 This is the directory where Python extension modules (shared libraries)
8016 should be installed. An extension module written in C could be declared
8017 as follows to Automake:
8019 @c Keep in sync with primary-prefix-couples-documented-valid.sh
8021 pyexec_LTLIBRARIES = quaternion.la
8022 quaternion_la_SOURCES = quaternion.c support.c support.h
8023 quaternion_la_LDFLAGS = -avoid-version -module
8027 This is a convenience variable that is defined as
8028 @samp{$(pyexecdir)/$(PACKAGE)}.
8031 All of these directory variables have values that can start with either
8032 @samp{$@{prefix@}} or @samp{$@{exec_prefix@}}, unexpanded. This works
8033 fine in @file{Makefile}s, but it makes these variables hard to use in
8034 @file{configure}. This is mandated by the GNU coding standards, so
8035 that the user can run @samp{make prefix=/foo install}. The Autoconf
8036 manual has a section with more details on this topic
8037 (@pxref{Installation Directory Variables, , Installation Directory
8038 Variables, autoconf, The Autoconf Manual}). See also @ref{Hard-Coded
8042 * Supported Python versions::
8045 @node Supported Python versions
8046 @subsection Supported versions
8048 Automake guarantees releases will support all Python versions that are still
8049 supported by the Python project at the time of the Automake release. Support
8050 for EOL versions of Python are not guaranteed, but will be considered as long
8051 as it is not onerous to do so, and there are large supported distros including
8052 them. If you need to support older Python versions, please use a previous
8055 Here are the current support plans.
8057 @multitable {2.0 -- 3.5} {Unsupported}
8058 @headitem Version @tab Status
8064 @tab Untested, but should work
8066 @c Debian Bullseye goes EOL in Apr 2026.
8067 @tab Supported (until Apr 2026)
8069 @tab Untested, but should work
8071 @c Ubuntu Trusty goes EOL in Apr 2022.
8072 @tab Supported (until Apr 2022)
8074 @c Ubuntu Xenial goes EOL in Apr 2024.
8075 @tab Supported (until Apr 2024)
8077 @c Ubuntu Bionic goes EOL in Apr 2028.
8078 @tab Supported (until Apr 2028)
8080 @c Debian Buster goes EOL in Apr 2024.
8081 @c But should support at least as long as previous Python version?
8082 @tab Supported (until Apr 2028)
8084 @c Ubuntu Focal goes EOL in Apr 2030
8085 @tab Supported (until Apr 2030)
8087 @c Debian Bullseye goes EOL in Apr 2026.
8088 @c But should support at least as long as previous Python version?
8089 @tab Supported (until Apr 2030)
8091 @c But should support at least as long as previous Python version?
8092 @tab Supported (until Apr 2030)
8096 @chapter Building documentation
8098 Currently Automake provides support for Texinfo and man pages.
8109 @cindex Texinfo support
8110 @cindex @code{_TEXINFOS} primary, defined
8111 @cindex @code{TEXINFOS} primary, defined
8112 @cindex Primary variable, @code{TEXINFOS}
8113 @cindex HTML output using Texinfo
8114 @cindex PDF output using Texinfo
8115 @cindex PS output using Texinfo
8116 @cindex DVI output using Texinfo
8118 @vindex info_TEXINFOS
8120 If the current directory contains Texinfo source, you must declare it
8121 with the @code{TEXINFOS} primary. Generally Texinfo files are converted
8122 into info, and thus the @code{info_TEXINFOS} variable is most commonly used
8123 here. Any Texinfo source file should have the @file{.texi} extension.
8124 Automake also accepts @file{.txi} or @file{.texinfo} extensions, but their
8125 use is discouraged now, and will elicit runtime warnings.
8127 Automake generates rules to build @file{.info}, @file{.dvi},
8128 @file{.ps}, @file{.pdf} and @file{.html} files from your Texinfo
8129 sources. Following the GNU Coding Standards, only the @file{.info}
8130 files are built by @samp{make all} and installed by @samp{make
8131 install} (unless you use @option{no-installinfo}, see below).
8132 Furthermore, @file{.info} files are automatically distributed so that
8133 Texinfo is not a prerequisite for installing your package.
8135 It is worth noting that, contrary to what happens with the other formats,
8136 the generated @file{.info} files are by default placed in @code{srcdir}
8137 rather than in the @code{builddir}. This can be changed with the
8138 @option{info-in-builddir} option.
8140 If the Texinfo sources are in a subdirectory relative to the Makefile, then
8141 @code{-I} flags for the subdirectory, both in the source directory and in the
8142 build directory, will automatically be added. There is no need to specify
8143 these in @samp{$(MAKEINFO)}, @samp{$(MAKEINFOFLAGS)}, etc.
8145 @cindex @samp{@@setfilename} Texinfo directive
8146 If a Texinfo source file contains an @samp{@@setfilename} directive,
8147 and its argument has extension @samp{.info} (or no extension, but this
8148 is discouraged), that argument should be the same as the basename of
8149 the Texinfo file, extended with @samp{.info}. The Make rules
8150 generated by Automake assume this, and will not work if the
8151 @samp{@@setfilename} is for some other name.
8153 @cindex @file{.texi.in} file, read
8154 If a Texinfo source @samp{foo.texi} is not present, but
8155 @file{foo.texi.in} exists, Texinfo will read that @file{.texi.in} file
8156 for @code{@@setfilename} and @code{@@include version.texi} (described
8159 Texinfo source files need not be present at all, and if present, need
8160 not contain @code{@@setfilename}. Then the file name given in the
8161 Makefile.am will be used.
8167 @trindex install-dvi
8168 @trindex install-html
8169 @trindex install-pdf
8171 Other documentation formats can be built on request by @samp{make
8172 dvi}, @samp{make ps}, @samp{make pdf} and @samp{make html}, and they
8173 can be installed with @samp{make install-dvi}, @samp{make install-ps},
8174 @samp{make install-pdf} and @samp{make install-html} explicitly.
8175 @samp{make uninstall} will remove everything: the Texinfo
8176 documentation installed by default as well as all the above optional
8179 All of these targets can be extended using @samp{-local} rules
8180 (@pxref{Extending}).
8182 @cindex Texinfo flag, @code{VERSION}
8183 @cindex Texinfo flag, @code{UPDATED}
8184 @cindex Texinfo flag, @code{EDITION}
8185 @cindex Texinfo flag, @code{UPDATED-MONTH}
8187 @cindex @code{VERSION} Texinfo flag
8188 @cindex @code{UPDATED} Texinfo flag
8189 @cindex @code{EDITION} Texinfo flag
8190 @cindex @code{UPDATED-MONTH} Texinfo flag
8192 @cindex @file{mdate-sh}
8194 If a @file{.texi} file @code{@@include}s @file{version.texi} (actually
8195 any file named @file{vers...texi}, then that file will be
8196 automatically generated. The file @file{version.texi} defines four
8197 Texinfo flags you can reference using @code{@@value@{EDITION@}},
8198 @code{@@value@{VERSION@}}, @code{@@value@{UPDATED@}}, and
8199 @code{@@value@{UPDATED-MONTH@}}.
8204 Both of these flags hold the version number of your program. They are
8205 kept separate for clarity.
8208 This holds the date the primary @file{.texi} file was last modified.
8211 This holds the name of the month in which the primary @file{.texi} file
8215 The @file{version.texi} support requires the @command{mdate-sh}
8216 script; this script is supplied with Automake and automatically
8217 included when @command{automake} is invoked with the
8218 @option{--add-missing} option.
8220 If you have multiple Texinfo files, and you want to use the
8221 @file{version.texi} feature, then you have to have a separate version
8222 file for each Texinfo file. Automake will treat any include in a
8223 Texinfo file that matches @file{vers*.texi} just like an automatically
8224 generated version file.
8226 Often an Info file depends on more than one @file{.texi} file. For
8227 instance, in GNU Hello, @file{hello.texi} includes the file
8228 @file{fdl.texi}. You can tell Automake about these dependencies using
8229 the @code{@var{texi}_TEXINFOS} variable. Here is how GNU Hello does
8235 info_TEXINFOS = hello.texi
8236 hello_TEXINFOS = fdl.texi
8239 @cindex @file{texinfo.tex}
8241 By default, Automake requires the file @file{texinfo.tex} to appear in
8242 the same directory as the @file{Makefile.am} file that lists the
8243 @file{.texi} files. If you used @code{AC_CONFIG_AUX_DIR} in
8244 @file{configure.ac} (@pxref{Input, , Finding `configure' Input,
8245 autoconf, The Autoconf Manual}), then @file{texinfo.tex} is looked for
8246 there. In both cases, @command{automake} then supplies @file{texinfo.tex} if
8247 @option{--add-missing} is given, and takes care of its distribution.
8248 However, if you set the @code{TEXINFO_TEX} variable (see below),
8249 it overrides the location of the file and turns off its installation
8250 into the source as well as its distribution.
8252 The option @option{no-texinfo.tex} can be used to eliminate the
8253 requirement for the file @file{texinfo.tex}. Use of the variable
8254 @code{TEXINFO_TEX} is preferable, however, because that allows the
8255 @code{dvi}, @code{ps}, and @code{pdf} targets to still work.
8257 @cindex Option, @code{no-installinfo}
8258 @cindex Target, @code{install-info}
8259 @cindex @code{install-info} target
8260 @cindex @code{no-installinfo} option
8262 @opindex no-installinfo
8263 @trindex install-info
8265 Automake generates an @code{install-info} rule; some people apparently
8266 use this. By default, info pages are installed by @samp{make
8267 install}, so running @code{make install-info} is pointless. This can
8268 be prevented via the @code{no-installinfo} option. In this case,
8269 @file{.info} files are not installed by default, and user must
8270 request this explicitly using @samp{make install-info}.
8272 @vindex AM_UPDATE_INFO_DIR
8273 By default, @code{make install-info} and @code{make uninstall-info}
8274 will try to run the @command{install-info} program (if available) to
8275 update (or create/remove) the @file{@code{$@{infodir@}}/dir} index.
8276 If this is undesired, it can be prevented by exporting the
8277 @code{AM_UPDATE_INFO_DIR} variable to "@code{no}".
8279 The following variables are used by the Texinfo build rules.
8283 The name of the program invoked to build @file{.info} files. This
8284 variable is defined by Automake. If the @command{makeinfo} program is
8285 found on the system then it will be used by default; otherwise
8286 @command{missing} will be used instead.
8289 The command invoked to build @file{.html} files. Automake
8290 defines this to @samp{$(MAKEINFO) --html}.
8293 User flags passed to each invocation of @samp{$(MAKEINFO)} and
8294 @samp{$(MAKEINFOHTML)}. This user variable (@pxref{User Variables}) is
8295 not expected to be defined in any @file{Makefile}; it can be used by
8296 users to pass extra flags to suit their needs.
8298 @item AM_MAKEINFOFLAGS
8299 @itemx AM_MAKEINFOHTMLFLAGS
8300 @itemx AM_TEXI2FLAGS
8301 Maintainer flags passed to each @command{makeinfo} invocation. Unlike
8302 @code{MAKEINFOFLAGS}, these variables are meant to be defined by
8303 maintainers in @file{Makefile.am}. @samp{$(AM_MAKEINFOFLAGS)} is
8304 passed to @code{makeinfo} when building @file{.info} files;
8305 @samp{$(AM_MAKEINFOHTMLFLAGS)} is used when building @file{.html}
8306 files; and @samp{$(AM_TEXI2FLAGS)} is used when building @file{.dvi} and
8309 @c Keep in sync with txinfo-many-output-formats.sh
8310 For instance, the following setting can be used to obtain one single
8311 @file{.html} file per manual, without node separators.
8313 AM_MAKEINFOHTMLFLAGS = --no-headers --no-split
8316 @code{AM_MAKEINFOHTMLFLAGS} defaults to @samp{$(AM_MAKEINFOFLAGS)}.
8317 This means that defining @code{AM_MAKEINFOFLAGS} without defining
8318 @code{AM_MAKEINFOHTMLFLAGS} will impact builds of both @file{.info}
8319 and @file{.html} files.
8322 The name of the command that converts a @file{.texi} file into a
8323 @file{.dvi} file. This defaults to @samp{texi2dvi}, a script that ships
8324 with the Texinfo package.
8327 The name of the command that translates a @file{.texi} file into a
8328 @file{.pdf} file. This defaults to @samp{$(TEXI2DVI) --pdf --batch}.
8331 The name of the command that builds a @file{.ps} file out of a
8332 @file{.dvi} file. This defaults to @samp{dvips}.
8335 If your package has Texinfo files in many directories, you can use the
8336 variable @code{TEXINFO_TEX} to tell Automake where to find the canonical
8337 @file{texinfo.tex} for your package. The value of this variable should
8338 be the relative path from the current @file{Makefile.am} to
8342 TEXINFO_TEX = ../doc/texinfo.tex
8350 @cindex @code{_MANS} primary, defined
8351 @cindex @code{MANS} primary, defined
8352 @cindex Primary variable, @code{MANS}
8356 A package can also include man pages (but see the GNU standards on this
8357 matter, @ref{Man Pages, , , standards, The GNU Coding Standards}.) Man
8358 pages are declared using the @code{MANS} primary. Generally the
8359 @code{man_MANS} variable is used. Man pages are automatically installed in
8360 the correct subdirectory of @code{mandir}, based on the file extension.
8362 File extensions such as @file{.1c} are handled by looking for the valid
8363 part of the extension and using that to determine the correct
8364 subdirectory of @code{mandir}. Valid section names are the digits
8365 @samp{0} through @samp{9}, and the letters @samp{l} and @samp{n}.
8367 Sometimes developers prefer to name a man page something like
8368 @file{foo.man} in the source, and then rename it to have the correct
8369 suffix, for example @file{foo.1}, when installing the file. Automake
8370 also supports this mode. For a valid section named @var{section},
8371 there is a corresponding directory named @samp{man@var{section}dir},
8372 and a corresponding @code{_MANS} variable. Files listed in such a
8373 variable are installed in the indicated section. If the file already
8374 has a valid suffix, then it is installed as-is; otherwise the file
8375 suffix is changed to match the section.
8377 For instance, consider this example:
8379 man1_MANS = rename.man thesame.1 alsothesame.1c
8383 In this case, @file{rename.man} will be renamed to @file{rename.1} when
8384 installed, but the other files will keep their names.
8386 @cindex Target, @code{install-man}
8387 @cindex Option, @option{no-installman}
8388 @cindex @code{install-man} target
8389 @cindex @option{no-installman} option
8390 @opindex no-installman
8391 @trindex install-man
8393 By default, man pages are installed by @samp{make install}. However,
8394 since the GNU project does not require man pages, many maintainers do
8395 not expend effort to keep the man pages up to date. In these cases, the
8396 @option{no-installman} option will prevent the man pages from being
8397 installed by default. The user can still explicitly install them via
8398 @samp{make install-man}.
8400 For fast installation, with many files it is preferable to use
8401 @samp{man@var{section}_MANS} over @samp{man_MANS} as well as files that
8402 do not need to be renamed.
8404 Man pages are not currently considered to be source, because it is not
8405 uncommon for man pages to be automatically generated. Therefore they
8406 are not automatically included in the distribution. However, this can
8407 be changed by use of the @code{dist_} prefix. For instance here is
8408 how to distribute and install the two man pages of GNU @command{cpio}
8409 (which includes both Texinfo documentation and man pages):
8412 dist_man_MANS = cpio.1 mt.1
8415 The @code{nobase_} prefix is meaningless for man pages and is
8419 @cindex @code{notrans_} prefix
8420 @cindex Man page renaming, avoiding
8421 @cindex Avoiding man page renaming
8423 Executables and manpages may be renamed upon installation
8424 (@pxref{Renaming}). For manpages this can be avoided by use of the
8425 @code{notrans_} prefix. For instance, suppose an executable @samp{foo}
8426 allowing to access a library function @samp{foo} from the command line.
8427 The way to avoid renaming of the @file{foo.3} manpage is:
8431 notrans_man_MANS = foo.3
8434 @cindex @code{notrans_} and @code{dist_} or @code{nodist_}
8435 @cindex @code{dist_} and @code{notrans_}
8436 @cindex @code{nodist_} and @code{notrans_}
8438 @samp{notrans_} must be specified first when used in conjunction with
8439 either @samp{dist_} or @samp{nodist_} (@pxref{Fine-grained Distribution
8440 Control}). For instance:
8443 notrans_dist_man3_MANS = bar.3
8447 @chapter What Gets Installed
8449 @cindex Installation support
8450 @cindex @samp{make install} support
8452 Naturally, Automake handles the details of installing your program
8453 once it has been built. All files named by the various primaries are
8454 automatically installed in the appropriate places when the user runs
8455 @samp{make install}.
8458 * Basics of Installation:: What gets installed where
8459 * The Two Parts of Install:: Installing data and programs separately
8460 * Extending Installation:: Adding your own rules for installation
8461 * Staged Installs:: Installation in a temporary location
8462 * Install Rules for the User:: Useful additional rules
8465 @node Basics of Installation
8466 @section Basics of Installation
8468 A file named in a primary is installed by copying the built file into
8469 the appropriate directory. The base name of the file is used when
8473 bin_PROGRAMS = hello subdir/goodbye
8476 In this example, both @samp{hello} and @samp{goodbye} will be installed
8477 in @samp{$(bindir)}.
8479 Sometimes it is useful to avoid the basename step at install time. For
8480 instance, you might have a number of header files in subdirectories of
8481 the source tree that are laid out precisely how you want to install
8482 them. In this situation you can use the @code{nobase_} prefix to
8483 suppress the base name step. For example:
8486 nobase_include_HEADERS = stdio.h sys/types.h
8490 will install @file{stdio.h} in @samp{$(includedir)} and @file{types.h}
8491 in @samp{$(includedir)/sys}.
8493 For most file types, Automake will install multiple files at once, while
8494 avoiding command line length issues (@pxref{Length Limitations}). Since
8495 some @command{install} programs will not install the same file twice in
8496 one invocation, you may need to ensure that file lists are unique within
8497 one variable such as @samp{nobase_include_HEADERS} above.
8499 You should not rely on the order in which files listed in one variable
8500 are installed. Likewise, to cater for parallel make, you should not
8501 rely on any particular file installation order even among different
8502 file types (library dependencies are an exception here).
8505 @node The Two Parts of Install
8506 @section The Two Parts of Install
8508 Automake generates separate @code{install-data} and @code{install-exec}
8509 rules, in case the installer is installing on multiple machines that
8510 share directory structure---these targets allow the machine-independent
8511 parts to be installed only once. @code{install-exec} installs
8512 platform-dependent files, and @code{install-data} installs
8513 platform-independent files. The @code{install} target depends on both
8514 of these targets. While Automake tries to automatically segregate
8515 objects into the correct category, the @file{Makefile.am} author is, in
8516 the end, responsible for making sure this is done correctly.
8517 @trindex install-data
8518 @trindex install-exec
8520 @cindex Install, two parts of
8522 Variables using the standard directory prefixes @samp{data},
8523 @samp{info}, @samp{man}, @samp{include}, @samp{oldinclude},
8524 @samp{pkgdata}, or @samp{pkginclude} are installed by
8525 @code{install-data}.
8527 Variables using the standard directory prefixes @samp{bin},
8528 @samp{sbin}, @samp{libexec}, @samp{sysconf}, @samp{localstate},
8529 @samp{lib}, or @samp{pkglib} are installed by @code{install-exec}.
8531 For instance, @code{data_DATA} files are installed by @code{install-data},
8532 while @code{bin_PROGRAMS} files are installed by @code{install-exec}.
8534 Any variable using a user-defined directory prefix with
8535 @samp{exec} in the name (e.g.,
8536 @c Keep in sync with primary-prefix-couples-documented-valid.sh
8537 @code{myexecbin_PROGRAMS}) is installed by @code{install-exec}. All
8538 other user-defined prefixes are installed by @code{install-data}.
8540 @node Extending Installation
8541 @section Extending Installation
8543 It is possible to extend this mechanism by defining an
8544 @code{install-exec-local} or @code{install-data-local} rule. If these
8545 rules exist, they will be run at @samp{make install} time. These
8546 rules can do almost anything; care is required.
8547 @trindex install-exec-local
8548 @trindex install-data-local
8550 Automake also supports two install hooks, @code{install-exec-hook} and
8551 @code{install-data-hook}. These hooks are run after all other install
8552 rules of the appropriate type, exec or data, have completed. So, for
8553 instance, it is possible to perform post-installation modifications
8554 using an install hook. @xref{Extending}, for some examples.
8555 @cindex Install hook
8557 @node Staged Installs
8558 @section Staged Installs
8561 Automake generates support for the @code{DESTDIR} variable in all
8562 install rules. @code{DESTDIR} is used during the @samp{make install}
8563 step to relocate install objects into a staging area. Each object and
8564 path is prefixed with the value of @code{DESTDIR} before being copied
8565 into the install area. Here is an example of typical DESTDIR usage:
8568 mkdir /tmp/staging &&
8569 make DESTDIR=/tmp/staging install
8572 The @command{mkdir} command avoids a security problem if the attacker
8573 creates a symbolic link from @file{/tmp/staging} to a victim area;
8574 then @command{make} places install objects in a directory tree built under
8575 @file{/tmp/staging}. If @file{/gnu/bin/foo} and
8576 @file{/gnu/share/aclocal/foo.m4} are to be installed, the above command
8577 would install @file{/tmp/staging/gnu/bin/foo} and
8578 @file{/tmp/staging/gnu/share/aclocal/foo.m4}.
8580 This feature is commonly used to build install images and packages
8583 Support for @code{DESTDIR} is implemented by coding it directly into
8584 the install rules. If your @file{Makefile.am} uses a local install
8585 rule (e.g., @code{install-exec-local}) or an install hook, then you
8586 must write that code to respect @code{DESTDIR}.
8588 @xref{Makefile Conventions, , , standards, The GNU Coding Standards},
8589 for another usage example.
8591 @node Install Rules for the User
8592 @section Install Rules for the User
8594 Automake also generates rules for targets @code{uninstall},
8595 @code{installdirs}, and @code{install-strip}.
8597 @trindex installdirs
8598 @trindex install-strip
8600 Automake supports @code{uninstall-local} and @code{uninstall-hook}.
8601 There is no notion of separate uninstalls for ``exec'' and ``data'', as
8602 these features would not provide additional functionality.
8604 Note that @code{uninstall} is not meant as a replacement for a real
8609 @chapter What Gets Cleaned
8611 @cindex @samp{make clean} support
8613 The GNU Makefile Standards specify a number of different clean rules.
8614 @xref{Standard Targets, , Standard Targets for Users, standards,
8615 The GNU Coding Standards}.
8617 Generally the files that can be cleaned are determined automatically by
8618 Automake. Of course, Automake also recognizes some variables that can
8619 be defined to specify additional files to clean. These variables are
8620 @code{MOSTLYCLEANFILES}, @code{CLEANFILES}, @code{DISTCLEANFILES}, and
8621 @code{MAINTAINERCLEANFILES}.
8622 @vindex MOSTLYCLEANFILES
8624 @vindex DISTCLEANFILES
8625 @vindex MAINTAINERCLEANFILES
8627 @trindex mostlyclean-local
8628 @trindex clean-local
8629 @trindex distclean-local
8630 @trindex maintainer-clean-local
8631 When cleaning involves more than deleting some hard-coded list of
8632 files, it is also possible to supplement the cleaning rules with your
8633 own commands. Simply define a rule for any of the
8634 @code{mostlyclean-local}, @code{clean-local}, @code{distclean-local},
8635 or @code{maintainer-clean-local} targets (@pxref{Extending}). A common
8636 case is deleting a directory, for instance, a directory created by the
8644 Since @command{make} allows only one set of rules for a given target,
8645 a more extensible way of writing this is to use a separate target
8646 listed as a dependency:
8649 clean-local: clean-local-check
8650 .PHONY: clean-local-check
8655 As the GNU Standards aren't always explicit as to which files should
8656 be removed by which rule, we've adopted a heuristic that we believe
8657 was first formulated by Fran@,{c}ois Pinard:
8661 If @command{make} built it, and it is commonly something that one would
8662 want to rebuild (for instance, a @file{.o} file), then
8663 @code{mostlyclean} should delete it.
8666 Otherwise, if @command{make} built it, then @code{clean} should delete it.
8669 If @command{configure} built it, then @code{distclean} should delete it.
8672 If the maintainer built it (for instance, a @file{.info} file), then
8673 @code{maintainer-clean} should delete it. However
8674 @code{maintainer-clean} should not delete anything that needs to exist
8675 in order to run @samp{./configure && make}.
8678 We recommend that you follow this same set of heuristics in your
8683 @chapter What Goes in a Distribution
8686 * Basics of Distribution:: Files distributed by default
8687 * Fine-grained Distribution Control:: @code{dist_} and @code{nodist_} prefixes
8688 * The dist Hook:: A target for last-minute distribution changes
8689 * Checking the Distribution:: @samp{make distcheck} explained
8690 * The Types of Distributions:: A variety of formats and compression methods
8693 @node Basics of Distribution
8694 @section Basics of Distribution
8696 @cindex @samp{make dist}
8701 The @code{dist} rule in the generated @file{Makefile.in} can be used
8702 to generate a gzipped @code{tar} file and/or other flavors of archives
8703 for distribution. The file is named based on the @code{PACKAGE} and
8704 @code{VERSION} variables automatically defined by either the
8705 @code{AC_INIT} invocation or by a @emph{deprecated} two-arguments
8706 invocation of the @code{AM_INIT_AUTOMAKE} macro (see @ref{Public
8707 Macros} for how these variables get their values, from either defaults
8708 or explicit values---it's slightly trickier than one would expect).
8709 More precisely, the gzipped @code{tar} file is named
8710 @samp{$@{PACKAGE@}-$@{VERSION@}.tar.gz}.
8712 @c See automake #9822.
8714 You can set the environment (or @code{Makefile.am}) variable @code{TAR}
8715 to override the tar program used; it defaults to @code{tar}.
8716 @xref{The Types of Distributions}, for how to generate other kinds of
8720 With GNU tar, you can also set the environment (or @code{Makefile.am})
8721 variable @code{TAR_OPTIONS} to pass options to @code{tar}. One common
8722 case for this is wanting to avoid using the local user's uid and gid
8723 in the tar file, or the uid being larger than is supported by the tar
8724 format (not uncommon nowadays). This can be done with, for example>
8727 TAR_OPTIONS = --owner=0 --group=0
8732 The @code{export} (a GNU make feature) is necessary to pass the
8733 variable in the environment to the @code{tar} invocation.
8734 (For more discussion, see @url{https://bugs.gnu.org/19615}.)
8736 For the most part, the files to distribute are automatically
8741 All source files are automatically included in a distribution, as are
8742 all @file{Makefile.am} and @file{Makefile.in} files.
8744 @acindex AC_CONFIG_FILES
8746 Files that are read by @command{configure} are automatically
8747 distributed. These are the source files as specified in various
8748 Autoconf macros such as @code{AC_CONFIG_FILES} and siblings.
8750 @cindex @code{m4_include}, distribution
8751 @cindex @code{include}, distribution
8755 Files included in a @file{Makefile.am} (using @code{include}) or in
8756 @file{configure.ac} (using @code{m4_include}).
8759 Automake has a built-in list of commonly used files automatically
8760 included in the distribution if they are found in the current
8761 directory (either physically, or as the target of a @file{Makefile.am}
8762 rule). Some common examples: @file{ABOUT-GNU}, @file{COPYING},
8765 This list also includes helper scripts installed with @samp{automake
8766 --add-missing}. Some common examples: @file{compile},
8767 @file{config.guess}, @file{config.rpath}, @file{config.sub},
8771 Automake has another built-in list of files automatically distributed
8772 if they are found either with the plain name, or with extension
8773 @file{.md} (presumably MarkDown, though this not checked). They are
8774 checked for in that order, so the plain name is preferred. These are:
8775 @file{AUTHORS ChangeLog INSTALL NEWS README README-alpha THANKS}.
8778 A final built-in list of files are those distributed only if other
8779 certain conditions hold. For example,
8780 @c Keep in sync with autodist-config-headers.sh
8781 the files @file{config.h.top} and @file{config.h.bot} are
8782 automatically distributed only if, e.g.,
8783 @samp{AC_CONFIG_HEADERS([config.h])} is used in @file{configure.ac}).
8784 @file{README-alpha} is another such file, with @file{README-alpha.md}
8785 distributed if that is what is available; @pxref{Strictness}, for its
8786 conditions for distribution.
8791 These three lists of files are given in their entirety in the output
8792 from @code{automake --help}.
8795 Despite all this automatic inclusion, it is still common to have files
8796 to be distributed which are not found by the automatic rules. You
8797 should listed these files in the @code{EXTRA_DIST} variable. You can
8798 mention files in subdirectories in @code{EXTRA_DIST}.
8800 You can also mention a directory in @code{EXTRA_DIST}; in this case
8801 the entire directory will be recursively copied into the distribution.
8802 To emphasize, this copies @emph{everything} in the directory,
8803 including temporary editor files, intermediate build files, version
8804 control files, etc.; thus we recommend against using this feature
8805 as-is. However, you can use the @code{dist-hook} feature to
8806 ameliorate the problem; @pxref{The dist Hook}.
8809 @vindex DIST_SUBDIRS
8810 If you define @code{SUBDIRS}, Automake will recursively include the
8811 subdirectories in the distribution. If @code{SUBDIRS} is defined
8812 conditionally (@pxref{Conditionals}), Automake will normally include
8813 all directories that could possibly appear in @code{SUBDIRS} in the
8814 distribution. If you need to specify the set of directories
8815 conditionally, you can set the variable @code{DIST_SUBDIRS} to the
8816 exact list of subdirectories to include in the distribution
8817 (@pxref{Conditional Subdirectories}).
8820 @node Fine-grained Distribution Control
8821 @section Fine-grained Distribution Control
8825 Sometimes you need tighter control over what does @emph{not} go into the
8826 distribution; for instance, you might have source files that are
8827 generated and that you do not want to distribute. In this case
8828 Automake gives fine-grained control using the @code{dist} and
8829 @code{nodist} prefixes. Any primary or @code{_SOURCES} variable can be
8830 prefixed with @code{dist_} to add the listed files to the distribution.
8831 Similarly, @code{nodist_} can be used to omit the files from the
8834 As an example, here is how you would cause some data to be distributed
8835 while leaving some source code out of the distribution:
8838 dist_data_DATA = distribute-this
8840 nodist_foo_SOURCES = do-not-distribute.c
8844 @section The dist Hook
8848 Occasionally it is useful to be able to change the distribution before
8849 it is packaged up. If the @code{dist-hook} rule exists, it is run
8850 after the distribution directory is filled, but before the actual
8851 distribution archives are created. One way to use this is for
8852 removing unnecessary files that get recursively included by specifying
8853 a directory in @code{EXTRA_DIST}:
8858 chmod -R u+w $(distdir)/doc
8859 rm -rf `find $(distdir)/doc -type d -name RCS`
8862 @c The caveats described here should be documented in 'disthook.sh'.
8864 The @code{dist-hook} recipe should not assume that the regular files
8865 in the distribution directory are writable; this might not be the case
8866 if one is packaging from a read-only source tree, or when a @code{make
8867 distcheck} is being done. Similarly, the recipe should not assume
8868 that the subdirectories put into the distribution directory as a
8869 result of being listed in @code{EXTRA_DIST} are writable. So, if the
8870 @code{dist-hook} recipe wants to modify the content of an existing
8871 file (or @code{EXTRA_DIST} subdirectory) in the distribution
8872 directory, it should explicitly to make it writable first:
8875 EXTRA_DIST = README doc
8877 chmod u+w $(distdir)/README $(distdir)/doc
8878 echo "Distribution date: `date`" >> $(distdir)/README
8879 rm -f $(distdir)/doc/HACKING
8884 Two variables that come handy when writing @code{dist-hook} rules are
8885 @samp{$(distdir)} and @samp{$(top_distdir)}.
8887 @samp{$(distdir)} points to the directory where the @code{dist} rule
8888 will copy files from the current directory before creating the
8889 tarball. If you are at the top-level directory, then @samp{distdir =
8890 $(PACKAGE)-$(VERSION)}. When used from subdirectory named
8891 @file{foo/}, then @samp{distdir = ../$(PACKAGE)-$(VERSION)/foo}.
8892 @samp{$(distdir)} can be either a relative or absolute path; do not
8893 assume a particular form.
8895 @samp{$(top_distdir)} always points to the root directory of the
8896 distributed tree. At the top level it's equal to @samp{$(distdir)}.
8897 In the @file{foo/} subdirectory @samp{top_distdir =
8898 ../$(PACKAGE)-$(VERSION)}. @samp{$(top_distdir)} can also be either a
8899 relative or absolute path.
8901 @acindex AC_CONFIG_SUBDIRS
8902 When packages are nested using @code{AC_CONFIG_SUBDIRS}
8903 (@pxref{Subpackages}), then @samp{$(distdir)} and
8904 @samp{$(top_distdir)} are relative to the package where @samp{make
8905 dist} was run, not to any sub-packages involved.
8907 @node Checking the Distribution
8908 @section Checking the Distribution
8910 @cindex @samp{make distcheck}
8912 Automake also generates a @code{distcheck} rule that can be of help
8913 to ensure that a given distribution will actually work. Simplifying
8914 a bit, we can say this rule first makes a distribution, and then,
8915 @emph{operating from it}, takes the following steps (in this order):
8918 does a @code{VPATH} build (@pxref{VPATH Builds}), with the
8919 @code{srcdir} and all its content made @emph{read-only};
8921 makes the printable documentation (with @command{make dvi}), if any,
8923 runs the test suite (with @command{make check}) on this fresh build;
8925 installs the package in a temporary directory (with @command{make
8926 install}), and runs the test suite on the resulting installation
8927 (with @command{make installcheck});
8929 checks that the package can be correctly uninstalled (by @command{make
8930 uninstall}) and cleaned (by @code{make distclean});
8932 finally, makes another tarball to ensure the distribution is
8936 All of these actions are performed in a temporary directory. The
8937 exact location and the exact structure of such a directory (where the
8938 read-only sources are placed, how the temporary build and install
8939 directories are named and how deeply they are nested, etc.) is to be
8940 considered an implementation detail, which can change at any time, so
8941 please do not rely on it.
8944 * DISTCHECK_CONFIGURE_FLAGS:: Overriding configure flags in distcheck.
8945 * distcheck-hook:: Running commands after distcheck.
8946 * dvi and distcheck:: Overriding the distcheck doc target.
8947 * distcleancheck:: Handling files not cleaned.
8948 * distuninstallcheck:: Overriding the uninstall check.
8949 * Errors with distclean::
8952 @node DISTCHECK_CONFIGURE_FLAGS
8953 @subsection @code{DISTCHECK_CONFIGURE_FLAGS}
8954 @vindex AM_DISTCHECK_CONFIGURE_FLAGS
8955 @vindex DISTCHECK_CONFIGURE_FLAGS
8957 Building the package involves running @samp{./configure}. If you need
8958 to supply additional flags to @command{configure}, define them in the
8959 @code{AM_DISTCHECK_CONFIGURE_FLAGS} variable in your top-level
8960 @file{Makefile.am}. The user can still extend or override the flags
8961 provided there by defining the @code{DISTCHECK_CONFIGURE_FLAGS} variable,
8962 on the command line when invoking @command{make}.
8963 @c See automake bug#14991 for more details about how the following holds.
8964 It's worth noting that @command{make distcheck} needs complete control
8965 over the @command{configure} options @option{--srcdir} and
8966 @option{--prefix}, so those options cannot be overridden by
8967 @code{AM_DISTCHECK_CONFIGURE_FLAGS} nor by
8968 @code{DISTCHECK_CONFIGURE_FLAGS}.
8970 Developers are encouraged to strive to make their code buildable
8971 without requiring any special configure option; thus, in general, you
8972 shouldn't define @code{AM_DISTCHECK_CONFIGURE_FLAGS}. GNU
8973 @command{m4} offers an example of when its use is justified, however.
8974 GNU @command{m4} configures by default with its experimental and
8975 seldom used @samp{changeword} feature disabled; so in this case it is
8976 useful to have @command{make distcheck} run configure with the
8977 @option{--with-changeword} option, to ensure that the code for
8978 changeword support still compiles correctly. GNU @command{m4} also
8979 employs the @code{AM_DISTCHECK_CONFIGURE_FLAGS} variable to
8980 stress-test the use of @option{--program-prefix=g}, since at one point
8981 the @command{m4} build system had a bug where @command{make
8982 installcheck} was wrongly assuming it could blindly test @samp{m4},
8983 rather than the just-installed @samp{gm4}.
8985 @node distcheck-hook
8986 @subsection @code{distcheck-hook}
8987 @trindex distcheck-hook
8989 If the @code{distcheck-hook} rule is defined in your top-level
8990 @file{Makefile.am}, then it will be invoked by @code{distcheck} after
8991 the new distribution has been unpacked, but before the unpacked copy
8992 is configured and built. Your @code{distcheck-hook} can do almost
8993 anything, though as always caution is advised. Generally this hook is
8994 used to check for potential distribution errors not caught by the
8997 @code{distcheck-hook}, as well as @code{AM_DISTCHECK_CONFIGURE_FLAGS}
8998 and @code{DISTCHECK_CONFIGURE_FLAGS}, are not honored in a subpackage
8999 @file{Makefile.am}, but the flags from
9000 @code{AM_DISTCHECK_CONFIGURE_FLAGS} and
9001 @code{DISTCHECK_CONFIGURE_FLAGS} are passed down to the
9002 @command{configure} script of the subpackage.
9004 @node dvi and distcheck
9005 @subsection @code{dvi} and @code{distcheck}
9008 Ordinarily, @command{make distcheck} runs @command{make dvi}. It does
9009 nothing if the distribution contains no Texinfo sources. If the
9010 distribution does contain a Texinfo manual, by default the @code{dvi}
9011 target will run @TeX{} to make sure it can be successfully processed
9014 @vindex AM_DISTCHECK_DVI_TARGET
9015 @cindex @code{eps} images, and @code{distcheck}
9016 However, you may wish to test the manual by producing @code{pdf}
9017 (e.g., if your manual uses images in formats other than @code{eps}),
9018 @code{html} (if you don't have @TeX{} at all), some other format, or
9019 just skip the test entirely (not recommended). You can change the
9020 target that is run by setting the variable
9021 @code{AM_DISTCHECK_DVI_TARGET} in your @code{Makefile.am}; for
9025 AM_DISTCHECK_DVI_TARGET = pdf
9028 To make @code{dvi} into a do-nothing target, see the example for
9029 @code{EMPTY_AUTOMAKE_TARGETS} in @ref{Third-Party Makefiles}.
9031 @node distcleancheck
9032 @subsection @code{distcleancheck}
9033 @cindex @samp{make distcleancheck}
9034 @trindex distcleancheck
9035 @vindex DISTCLEANFILES
9036 @vindex distcleancheck_listfiles
9038 @code{distcheck} ensures that the @code{distclean} rule actually
9039 removes all built files. This is done by running @samp{make
9040 distcleancheck} at the end of the @code{VPATH} build. By default,
9041 @code{distcleancheck} will run @code{distclean} and then make sure the
9042 build tree has been emptied by running the value of the variable
9043 @samp{$(distcleancheck_listfiles)}. Often this check will find
9044 generated files that you forgot to add to the @code{DISTCLEANFILES}
9045 variable (@pxref{Clean}).
9047 The @code{distcleancheck} behavior should be OK for most packages,
9048 otherwise you have the possibility to override the definition of
9049 either the @code{distcleancheck} rule, or the
9050 @samp{$(distcleancheck_listfiles)} variable. For instance, to disable
9051 @code{distcleancheck} completely (not recommended), add the following
9052 rule to your top-level @file{Makefile.am}:
9059 If you want @code{distcleancheck} to ignore built files that have not
9060 been cleaned because they are also part of the distribution, make the
9061 following definition:
9063 @c Keep in sync with t/distcleancheck.sh.
9065 distcleancheck_listfiles = \
9066 find . -type f -exec sh -c 'test -f $(srcdir)/$$1 || echo $$1' \
9070 The above definition is not the default because it's usually an error
9071 if your Makefiles cause some distributed files to be rebuilt when the
9072 user builds the package: consider the user missing the tool required
9073 to build the file; or if the required tool is built by your package,
9074 consider the cross-compilation case where it can't be run.
9076 Please see the (following) section @ref{Errors with distclean} before
9077 playing with @code{distcleancheck_listfiles}.
9079 @node distuninstallcheck
9080 @subsection @code{distuninstallcheck}
9081 @cindex @samp{make distuninstallcheck}
9082 @trindex distuninstallcheck
9083 @vindex distuninstallcheck_listfiles
9085 @code{distcheck} also checks that the @code{uninstall} rule works
9086 properly, both for ordinary and @code{DESTDIR} builds. It does this
9087 by invoking @samp{make uninstall}, and then it checks the install tree
9088 to see if any files are left over. This check will make sure that you
9089 correctly coded your @code{uninstall}-related rules.
9091 By default, the checking is done by the @code{distuninstallcheck}
9092 rule, and the list of files in the install tree is generated by
9093 @samp{$(distuninstallcheck_listfiles)}. The value of the latter
9094 variable is taken to be a shell command to run that prints the list of
9097 Either of these can be overridden to modify the behavior of
9098 @code{distcheck}. For instance, to disable this check completely (not
9099 recommended), you would write:
9106 @node Errors with distclean
9107 @subsection Errors with @code{distclean}
9108 @cindex @code{distclean}, diagnostic
9109 @cindex @samp{make distclean}, diagnostic
9110 @cindex dependencies and distributed files
9113 As explained in the section above (@pxref{Checking the Distribution}),
9114 @samp{make distcheck} attempts to build and check your package for
9115 errors. One such error you might see is:
9118 ERROR: files left in build directory after distclean:
9121 @noindent The file(s) left in the build directory after @samp{make distclean}
9122 has run are listed after this error message. This can happen in two
9126 @item files that were forgotten to be distclean-ed;
9127 @item distributed files that are erroneously rebuilt.
9130 In the first case of simple left-over files not intended to be
9131 distributed, the fix is to include them for cleaning (@pxref{Clean});
9132 this is straightforward and doesn't need more explanation.
9135 @cindex man pages, generating and distributing
9136 The second case, however, is not always easy to understand and fix, so
9137 let's proceed with an example. Suppose our package contains a program
9138 for which we want to build a man page using @command{help2man}. GNU
9139 @command{help2man} produces simple manual pages from the
9140 @option{--help} and @option{--version} output of other commands
9141 (@pxref{,,,help2man, The Help2man Manual}). Because we don't want to
9142 force our users to install @command{help2man}, we distribute the
9143 generated man page using the following setup.
9146 # This Makefile.am is bogus.
9149 dist_man_MANS = foo.1
9152 help2man --output=foo.1 ./foo$(EXEEXT)
9155 This will effectively distribute the man page. However,
9156 @samp{make distcheck} will fail with:
9159 ERROR: files left in build directory after distclean:
9163 Why was @file{foo.1} rebuilt? Because although distributed,
9164 @file{foo.1} depends on a non-distributed built file:
9165 @file{foo$(EXEEXT)}. @file{foo$(EXEEXT)} is built by the user, so it
9166 will always appear to be newer than the distributed @file{foo.1}.
9168 In other words, @samp{make distcheck} caught an inconsistency in our
9169 package. Our intent was to distribute @file{foo.1} so users do not
9170 need to install @command{help2man}, but since this rule causes this
9171 file to be always rebuilt, users @emph{do} need @command{help2man}.
9172 Either we should ensure that @file{foo.1} is not rebuilt by users, or
9173 there is no point in distributing @file{foo.1}.
9175 More generally, the rule is that distributed files should never depend
9176 on non-distributed built files. If you distribute something
9177 generated, distribute all its sources.
9179 One way to fix the above example, while still distributing
9180 @file{foo.1}, is to not depend on @file{foo$(EXEEXT)}, but instead on
9181 relevant source files. For instance, assuming @command{foo --version}
9182 and @command{foo --help} do not change unless @file{foo.c} or
9183 @file{configure.ac} change, we could write the following
9189 dist_man_MANS = foo.1
9191 foo.1: foo.c $(top_srcdir)/configure.ac
9192 $(MAKE) $(AM_MAKEFLAGS) foo$(EXEEXT)
9193 help2man --output=foo.1 ./foo$(EXEEXT)
9196 This way, @file{foo.1} will not get rebuilt every time
9197 @file{foo$(EXEEXT)} changes. The @command{make} call makes sure
9198 @file{foo$(EXEEXT)} is up-to-date before @command{help2man}.
9200 Another step towards ensuring this would be to use separate
9201 directories for binaries and man pages, and set @code{SUBDIRS} so that
9202 binaries are built before man pages. Unfortunately, this alone is, in
9203 general, not sufficient. In order to avoid to avoid concurrency bugs,
9204 it may be necessary to include wrappers; this is done by GNU Autoconf,
9207 We could also decide not to distribute @file{foo.1}. In this case
9208 it's fine to have @file{foo.1} dependent upon @file{foo$(EXEEXT)},
9209 since both will have to be rebuilt. However, it might be impossible
9210 to build the package in a cross-compilation, because building
9211 @file{foo.1} involves an @emph{execution} of @file{foo$(EXEEXT)}. The
9212 exception would be if @file{foo} is a platform-independent script,
9213 such as @command{help2man}.
9215 Another context where such errors are common is when distributed files
9216 are built by tools that are built by the package. The pattern is
9220 distributed-file: built-tools distributed-sources
9225 should be changed to
9228 distributed-file: distributed-sources
9229 $(MAKE) $(AM_MAKEFLAGS) built-tools
9234 or you could choose not to distribute @file{distributed-file}, if
9235 cross-compilation does not matter.
9237 The points made through these examples are worth summarizing:
9241 @item Distributed files should never depend upon non-distributed built files.
9243 @item Distributed files should be distributed with all their dependencies.
9245 @item If a file is @emph{intended} to be rebuilt by users, then there
9246 is no point in distributing it.
9250 Real-world examples for @code{help2man}:
9254 Autoconf takes the approach described above, including man pages in
9255 its releases. A wrapper for each script is needed to avoid concurrency
9256 problems. See its source file @code{autoconf/man/local.mk}, which has
9257 a good discussion of the necessary additional details.
9260 Automake itself takes another approach: it does @emph{not} include man
9261 pages in distributions; thus, every user generates them when building
9262 from the release tarballs. This is ok (only) because Automake also
9263 includes a copy of the @command{help2man} script, which is plausible
9264 because @command{help2man} is small, self-contained, and
9265 platform-independent. See the source file
9266 @code{automake/doc/local.mk}.
9269 @vrindex distcleancheck_listfiles
9270 If you're desperate, it's possible to disable this check completely by
9271 setting @code{distcleancheck_listfiles} (@pxref{distcleancheck}).
9272 Make sure you understand the reason why @samp{make distcheck}
9273 complains first. @code{distcleancheck_listfiles} is a way to
9274 @emph{hide} errors, not to fix them. You can always do better.
9276 @node The Types of Distributions
9277 @section The Types of Distributions
9279 Automake generates rules to provide archives of the project for
9280 distributions in various formats. Their targets are:
9283 @item @code{dist-gzip}
9287 @c See https://bugs.gnu.org/68151 about using -9 instead of --best.
9288 Generate a @samp{gzip} tar archive of the distribution. This is the
9289 only format enabled by default. By default, this rule makes
9290 @command{gzip} use a compression option of @option{-9} (more widely
9291 supported than @option{--best}). To make
9292 it use a different one, set the @env{GZIP_ENV} environment variable.
9293 For example, @samp{make dist-gzip GZIP_ENV=-7}. @env{GZIP_ENV} is not
9294 used when decompressing.
9296 @item @code{dist-bzip2}
9300 Generate a @samp{bzip2} tar archive of the distribution. bzip2
9301 archives are usually smaller than gzipped archives. By default, this
9302 rule makes @samp{bzip2} use a compression option of @option{-9}. To
9303 make it use a different one, set the @env{BZIP2} environment variable.
9305 @item @code{dist-lzip}
9309 Generate an @samp{lzip} tar archive of the distribution.
9310 @command{lzip} archives are usually smaller than
9311 @command{bzip2}-compressed archives. By default, this rule makes
9312 @samp{lzip} use a compression option of @option{-9}. To make it use a
9313 different one, set the @env{LZIP_OPT} environment variable.
9315 @item @code{dist-xz}
9319 Generate an @samp{xz} tar archive of the distribution. @command{xz}
9320 archives are usually smaller than @command{bzip2}-compressed archives.
9321 By default, this rule makes @samp{xz} use a compression option of
9322 @option{-e}. To make it use a different one, set the @env{XZ_OPT}
9323 environment variable. For example, run this command to use the
9324 default compression ratio, but with a progress indicator: @samp{make
9325 dist-xz XZ_OPT=-ve}.
9329 @item @code{dist-zip}
9330 Generate a @samp{zip} archive of the distribution.
9332 @item @code{dist-zstd}
9337 Generate a @code{zstd} tar archive of the distribution. By default,
9338 this rule makes @command{zstd} use a compression option of
9339 @option{-19}. To use a different setting, set the @env{ZSTD_OPT}
9340 environment variable. For example, run this command to use the
9341 default compression ratio, but with a progress indicator: @samp{make
9342 dist-zstd ZSTD_OPT=-19v}. However, note that for compatibility with
9343 @command{zstd} itself, you may instead set the @env{ZSTD_CLEVEL}
9344 environment variable, in which case, any @env{ZSTD_OPT} setting is
9347 @item @code{dist-shar}
9350 Generate a @samp{shar} archive of the distribution. This format
9351 archive is obsolescent, and use of this option is deprecated.
9352 It and the corresponding functionality will be removed altogether
9355 @item @code{dist-tarZ}
9358 Generate a tar archive of the distribution, compressed with the
9359 historical (and obsolescent) program @command{compress}. This
9360 option is deprecated, and it and the corresponding functionality
9361 will be removed altogether in Automake 2.0.
9366 The rule @code{dist} (and its historical synonym @code{dist-all})
9367 will create archives in all the enabled formats (@pxref{List of
9368 Automake options} for how to change this list). By default, only
9369 the @code{dist-gzip} target is enabled by @code{dist}.
9373 @chapter Support for test suites
9376 @cindex @code{make check}
9379 Automake can generate code to handle two kinds of test suites. One is
9380 based on integration with the @command{dejagnu} framework. The other
9381 (and most used) form is based on the use of generic test scripts, and
9382 its activation is triggered by the definition of the special @code{TESTS}
9383 variable. This second form allows for various degrees of sophistication
9384 and customization; in particular, it allows for concurrent execution
9385 of test scripts, use of established test protocols such as TAP, and
9386 definition of custom test drivers and test runners.
9389 In either case, the testsuite is invoked via @samp{make check}.
9392 * Generalities about Testing:: Concepts and terminology about testing
9393 * Simple Tests:: Listing test scripts in @code{TESTS}
9394 * Custom Test Drivers:: Writing and using custom test drivers
9395 * Using the TAP test protocol:: Integrating test scripts that use the TAP protocol
9396 * DejaGnu Tests:: Interfacing with the @command{dejagnu} testing framework
9397 * Install Tests:: Running tests on installed packages
9400 @node Generalities about Testing
9401 @section Generalities about Testing
9403 The purpose of testing is to determine whether a program or system behaves
9404 as expected (e.g., known inputs produce the expected outputs, error
9405 conditions are correctly handled or reported, and older bugs do not
9409 The minimal unit of testing is usually called @emph{test case}, or simply
9410 @emph{test}. How a test case is defined or delimited, and even what
9411 exactly @emph{constitutes} a test case, depends heavily on the testing
9412 paradigm and/or framework in use, so we won't attempt any more precise
9413 definition. The set of the test cases for a given program or system
9414 constitutes its @emph{testsuite}.
9416 @cindex test harness
9417 @cindex testsuite harness
9418 A @emph{test harness} (also @emph{testsuite harness}) is a program or
9419 software component that executes all (or part of) the defined test cases,
9420 analyzes their outcomes, and reports or registers these outcomes
9421 appropriately. Again, the details of how this is accomplished (and how
9422 the developer and user can influence it or interface with it) varies
9423 wildly, and we'll attempt no precise definition.
9426 @cindex test failure
9427 A test is said to @emph{pass} when it can determine that the condition or
9428 behaviour it means to verify holds, and is said to @emph{fail} when it can
9429 determine that such condition of behaviour does @emph{not} hold.
9432 Sometimes, tests can rely on non-portable tools or prerequisites, or
9433 simply make no sense on a given system (for example, a test checking a
9434 Windows-specific feature makes no sense on a GNU/Linux system). In
9435 this case, accordingly to the definition above, the tests can neither
9436 be considered passed nor failed; instead, they are @emph{skipped},
9437 that is, they are not run, or their result is in any case ignored for
9438 what concerns the count of failures and successes. Skips are usually
9439 explicitly reported though, so that the user will be aware that not
9440 all of the testsuite has been run.
9443 @cindex expected failure
9444 @cindex expected test failure
9446 @cindex unexpected pass
9447 @cindex unexpected test pass
9448 It's not uncommon, especially during early development stages, that some
9449 tests fail for known reasons, and that the developer doesn't want to
9450 tackle these failures immediately (this is especially true when the
9451 failing tests deal with corner cases). In this situation, the better
9452 policy is to declare that each of those failures is an @emph{expected
9453 failure} (or @emph{xfail}). In case a test that is expected to fail ends
9454 up passing instead, many testing environments will flag the result as a
9455 special kind of failure called @emph{unexpected pass} (or @emph{xpass}).
9458 @cindex Distinction between errors and failures in testsuites
9459 Many testing environments and frameworks distinguish between test failures
9460 and hard errors. As we've seen, a test failure happens when some invariant
9461 or expected behaviour of the software under test is not met. A @emph{hard
9462 error} happens when e.g., the set-up of a test case scenario fails, or when
9463 some other unexpected or highly undesirable condition is encountered (for
9464 example, the program under test experiences a segmentation fault).
9467 @section Simple Tests
9470 * Scripts-based Testsuites:: Automake-specific concepts and terminology
9471 * Serial Test Harness:: Older (and discouraged) serial test harness
9472 * Parallel Test Harness:: Generic concurrent test harness
9475 @node Scripts-based Testsuites
9476 @subsection Scripts-based Testsuites
9478 If the special variable @code{TESTS} is defined, its value is taken to be
9479 a list of programs or scripts to run in order to do the testing. Under
9480 the appropriate circumstances, it's possible for @code{TESTS} to list
9481 also data files to be passed to one or more test scripts defined by
9482 different means (the so-called ``log compilers'', @pxref{Parallel Test
9485 Test scripts can be executed serially or concurrently. Automake supports
9486 both these kinds of test execution, with the parallel test harness being
9487 the default. The concurrent test harness relies on the concurrence
9488 capabilities (if any) offered by the underlying @command{make}
9489 implementation, and can thus only be as good as those are.
9491 By default, only the exit statuses of the test scripts are considered when
9492 determining the testsuite outcome. But Automake allows also the use of
9493 more complex test protocols, either standard (@pxref{Using the TAP test
9494 protocol}) or custom (@pxref{Custom Test Drivers}). You can't
9495 enable such protocols when the serial harness is used, though.
9496 In the rest of this section we are going to concentrate mostly on
9497 protocol-less tests, since we cover test protocols in a later section
9498 (again, @pxref{Custom Test Drivers}).
9500 @cindex Exit status 77, special interpretation
9501 @cindex Exit status 99, special interpretation
9502 When no test protocol is in use, an exit status of 0 from a test script will
9503 denote a success, an exit status of 77 a skipped test, an exit status of 99
9504 a hard error, and any other exit status will denote a failure.
9506 @cindex Tests, expected failure
9507 @cindex Expected test failure
9509 @vindex DISABLE_HARD_ERRORS
9510 @cindex Disabling hard errors
9511 You may define the variable @code{XFAIL_TESTS} to a list of tests
9512 (usually a subset of @code{TESTS}) that are expected to fail; this will
9513 effectively reverse the result of those tests (with the provision that
9514 skips and hard errors remain untouched). You may also instruct the
9515 testsuite harness to treat hard errors like simple failures, by defining
9516 the @code{DISABLE_HARD_ERRORS} make variable to a nonempty value.
9518 Note however that, for tests based on more complex test protocols,
9519 the exact effects of @code{XFAIL_TESTS} and @code{DISABLE_HARD_ERRORS}
9520 might change, or they might even have no effect at all (for example,
9521 @c Keep this in sync with tap-no-disable-hard-errors.sh
9522 in tests using TAP, there is no way to disable hard errors, and the
9523 @code{DISABLE_HARD_ERRORS} variable has no effect on them).
9525 @anchor{Testsuite progress on console}
9526 @cindex Testsuite progress on console
9527 The result of each test case run by the scripts in @code{TESTS} will be
9528 printed on standard output, along with the test name. For test protocols
9529 that allow more test cases per test script (such as TAP), a number,
9530 identifier and/or brief description specific for the single test case is
9531 expected to be printed in addition to the name of the test script. The
9532 possible results (whose meanings should be clear from the previous
9533 @ref{Generalities about Testing}) are @code{PASS}, @code{FAIL},
9534 @code{SKIP}, @code{XFAIL}, @code{XPASS} and @code{ERROR}. Here is an
9535 example of output from a hypothetical testsuite that uses both plain
9537 @c Keep in sync with tap-doc.sh
9540 PASS: zardoz.tap 1 - Daemon started
9541 PASS: zardoz.tap 2 - Daemon responding
9542 SKIP: zardoz.tap 3 - Daemon uses /proc # SKIP /proc is not mounted
9543 PASS: zardoz.tap 4 - Daemon stopped
9546 XFAIL: mu.tap 2 # TODO frobnication not yet implemented
9550 A testsuite summary (expected to report at least the number of run,
9551 skipped and failed tests) will be printed at the end of the testsuite
9552 run. By default, the first line of the summary has the form:
9555 Testsuite summary for @var{package-string}
9558 @c See automake bug#11745.
9559 @vindex AM_TESTSUITE_SUMMARY_HEADER
9561 where @var{package-string} is the name and version of the package. If
9562 you have several independent test suites for different parts of the
9563 package, though, it can be misleading for each suite to imply it is
9564 for the whole package. Or, in complex projects, you may wish to add
9565 the current directory or other information to the testsuite header
9566 line. So you can override the @samp{ for @var{package-string}} suffix
9567 on that line by setting the @code{AM_TESTSUITE_SUMMARY_HEADER}
9568 variable. The value of this variable is used unquoted in a shell echo
9569 command, so you must include any necessary quotes. For example, the
9573 AM_TESTSUITE_SUMMARY_HEADER = ' for $(PACKAGE_STRING)'
9577 including the double quotes (interpreted by the shell) and the leading
9578 space (since the value is output directly after the @samp{Testsuite
9579 summary}). The @code{$(PACKAGE_STRING)} is substituted by @code{make}.
9581 @anchor{Simple tests and color-tests}
9582 @vindex AM_COLOR_TESTS
9583 @cindex Colorized testsuite output
9584 If the standard output is connected to a capable terminal, then the test
9585 results and the summary are colored appropriately. The developer and the
9586 user can disable colored output by setting the @command{make} variable
9587 @samp{AM_COLOR_TESTS=no}; the user can in addition force colored output
9588 even without a connecting terminal with @samp{AM_COLOR_TESTS=always}.
9589 It's also worth noting that some @command{make} implementations,
9590 when used in parallel mode, have slightly different semantics
9591 (@pxref{Parallel make,,, autoconf, The Autoconf Manual}), which can
9592 break the automatic detection of a connection to a capable terminal.
9593 If this is the case, the user will have to resort to the use of
9594 @samp{AM_COLOR_TESTS=always} in order to have the testsuite output
9597 Test programs that need data files should look for them in @code{srcdir}
9598 (which is both a make variable and an environment variable made available
9599 to the tests), so that they work when building in a separate directory
9600 (@pxref{Build Directories, , Build Directories , autoconf,
9601 The Autoconf Manual}), and in particular for the @code{distcheck} rule
9602 (@pxref{Checking the Distribution}).
9605 Automake ensures that each file listed in @code{TESTS} is built before
9606 it is run; you can list both source and derived programs (or scripts)
9607 in @code{TESTS}; the generated rule will look both in @code{srcdir} and
9608 `@file{..}'. For instance, you might want to run a C program as a test.
9609 To do this you would list its name in @code{TESTS} and also in
9610 @code{check_PROGRAMS}, and then specify it as you would any other
9613 @vindex check_PROGRAMS
9614 Programs listed in @code{check_PROGRAMS} (and @code{check_LIBRARIES},
9615 @code{check_LTLIBRARIES}, ...) are only built during @code{make
9616 check}, not during @code{make all}. You should list there any program
9617 needed by your tests that does not need to be built by @code{make
9618 all}. The programs in @code{check_PROGRAMS} are @emph{not}
9619 automatically added to @code{TESTS} because @code{check_PROGRAMS}
9620 usually lists programs used by the tests, not the tests themselves.
9621 If all your programs are in fact test cases, you can set @code{TESTS =
9625 * Testsuite Environment Overrides::
9628 @node Testsuite Environment Overrides
9629 @subsubsection Testsuite Environment Overrides
9631 @cindex Testsuite environment overrides
9632 @cindex Overriding testsuite environment
9634 @vindex TESTS_ENVIRONMENT
9635 @vindex AM_TESTS_ENVIRONMENT
9636 The @code{AM_TESTS_ENVIRONMENT} and @code{TESTS_ENVIRONMENT} variables can
9637 be used to run initialization code and set environment variables for the
9638 test scripts. The former variable is developer-reserved, and can be
9639 defined in the @file{Makefile.am}, while the latter is reserved for the
9640 user, which can employ it to extend or override the settings in the
9641 former; for this to work portably, however, the contents of a non-empty
9642 @code{AM_TESTS_ENVIRONMENT} @emph{must} be terminated by a semicolon.
9644 @vindex AM_TESTS_FD_REDIRECT
9645 The @code{AM_TESTS_FD_REDIRECT} variable can be used to define file
9646 descriptor redirections for the test scripts. One might think that
9647 @code{AM_TESTS_ENVIRONMENT} could be used for this purpose, but experience
9648 has shown that doing so portably is practically impossible. The main
9649 hurdle is constituted by Korn shells, which usually set the close-on-exec
9650 flag on file descriptors opened with the @command{exec} builtin, thus
9651 rendering an idiom like @code{AM_TESTS_ENVIRONMENT = exec 9>&2;}
9652 ineffectual. This issue also affects some Bourne shells, such as the
9653 HP-UX's @command{/bin/sh}.
9655 @c Keep in sync with tests-environment-backcompat.sh
9657 AM_TESTS_ENVIRONMENT = \
9658 ## Some environment initializations are kept in a separate shell
9659 ## file 'tests-env.sh', which can make it easier to also run tests
9660 ## from the command line.
9661 . $(srcdir)/tests-env.sh; \
9662 ## On Solaris, prefer more POSIX-compliant versions of the standard
9663 ## tools by default.
9664 if test -d /usr/xpg4/bin; then \
9665 PATH=/usr/xpg4/bin:$$PATH; export PATH; \
9668 @c $$ restore font-lock
9669 ## With this, the test scripts will be able to print diagnostic
9670 ## messages to the original standard error stream, even if the test
9671 ## driver redirects the stderr of the test scripts to a log file
9672 ## before executing them.
9673 AM_TESTS_FD_REDIRECT = 9>&2
9676 @c https://bugs.gnu.org/49309
9677 As another example, a notice that a test is starting can be emitted
9678 using @code{AM_TESTS_ENVIRONMENT} (for package maintainers) or
9679 @code{TESTS_ENVIRONMENT} by users:
9682 make -j12 ... TESTS_ENVIRONMENT='echo RUNNING: "$$f";' check
9686 The shell variable @code{$f} contains the test name. (Although
9687 technically this is not guaranteed, in practice it is extremely
9688 unlikely to ever change.) This can be helpful to see when trying to
9689 debug test failures.
9691 Notwithstanding these benefits, @code{AM_TESTS_ENVIRONMENT} is, for
9692 historical and implementation reasons, @emph{not} supported by the
9693 serial harness (@pxref{Serial Test Harness}).
9695 @node Serial Test Harness
9696 @subsection Older (and discouraged) Serial Test Harness
9697 @cindex @option{serial-tests}, Using
9699 First, note that today the use of this harness is strongly discouraged in
9700 favour of the parallel test harness (@pxref{Parallel Test Harness}).
9701 Still, there are a @emph{few} situations when the advantages offered by
9702 the parallel harness are irrelevant, and when test concurrency can
9703 even cause tricky problems. In those cases, it might make sense to
9704 still use the serial harness, for simplicity and reliability (we still
9705 suggest trying to give the parallel harness a shot though).
9707 The serial test harness is enabled by the Automake option
9708 @option{serial-tests}. It operates by simply running the tests serially,
9709 one at the time, without any I/O redirection. It's up to the user to
9710 implement logging of tests' output, if that's required or desired.
9712 For historical and implementation reasons, the @code{AM_TESTS_ENVIRONMENT}
9713 variable is @emph{not} supported by this harness (it will be silently
9714 ignored if defined); only @code{TESTS_ENVIRONMENT} is, and it is to be
9715 considered a developer-reserved variable. This is done so that, when
9716 using the serial harness, @code{TESTS_ENVIRONMENT} can be defined to an
9717 invocation of an interpreter through which the tests are to be run.
9718 For instance, the following setup may be used to run tests with Perl:
9721 TESTS_ENVIRONMENT = $(PERL) -Mstrict -w
9722 TESTS = foo.pl bar.pl baz.pl
9726 It's important to note that the use of @code{TESTS_ENVIRONMENT} endorsed
9727 here would be @emph{invalid} with the parallel harness. That harness
9728 provides a more elegant way to achieve the same effect, with the further
9729 benefit of freeing the @code{TESTS_ENVIRONMENT} variable for the user
9730 (@pxref{Parallel Test Harness}).
9732 Another, less serious limitation of the serial harness is that it
9733 doesn't distinguish between simple failures and hard errors; this is
9734 for historical reasons, and might be fixed in future Automake
9737 @node Parallel Test Harness
9738 @subsection Parallel Test Harness
9740 By default, Automake generated a parallel (concurrent) test harness. It
9741 features automatic collection of the test scripts output in @file{.log}
9742 files, concurrent execution of tests with @code{make -j}, specification
9743 of inter-test dependencies, lazy reruns of tests that have not completed
9744 in a prior run, and hard errors for exceptional failures.
9746 @anchor{Basics of test metadata}
9747 @vindex TEST_SUITE_LOG
9749 @cindex @file{.log} files
9750 @cindex @file{.trs} files
9751 @cindex test metadata
9752 The parallel test harness operates by defining a set of @command{make}
9753 rules that run the test scripts listed in @code{TESTS}, and, for each
9754 such script, save its output in a corresponding @file{.log} file and
9755 its results (and other ``metadata'', @pxref{API for Custom Test Drivers})
9756 in a corresponding @file{.trs} (as in @b{T}est @b{R}e@b{S}ults) file.
9757 @c We choose the '.trs' extension also because, at the time of writing,
9758 @c it isn't already used for other significant purposes; see e.g.:
9759 @c - http://filext.com/file-extension/trs
9760 @c - http://www.file-extensions.org/search/?searchstring=trs
9761 The @file{.log} file will contain all the output emitted by the test on
9762 its standard output and its standard error. The @file{.trs} file will
9763 contain, among the other things, the results of the test cases run by
9766 The parallel test harness will also create a summary log file,
9767 @code{TEST_SUITE_LOG}, which defaults to @file{test-suite.log} and requires
9768 a @file{.log} suffix. This file depends upon all the @file{.log} and
9769 @file{.trs} files created for the test scripts listed in @code{TESTS}.
9772 As with the serial harness above, by default one status line is printed
9773 per completed test, and a short summary after the suite has completed.
9774 However, standard output and standard error of the test are redirected
9775 to a per-test log file, so that parallel execution does not produce
9776 intermingled output. The output from failed tests is collected in the
9777 @file{test-suite.log} file. If the variable @samp{VERBOSE} is set, this
9778 file is output after the summary.
9780 @vindex TEST_EXTENSIONS
9782 Each couple of @file{.log} and @file{.trs} files is created when the
9783 corresponding test has completed. The set of log files is listed in
9784 the read-only variable @code{TEST_LOGS}, and defaults to @code{TESTS},
9785 with the executable extension if any (@pxref{EXEEXT}), as well as any
9786 suffix listed in @code{TEST_EXTENSIONS} removed, and @file{.log} appended.
9787 Results are undefined if a test file name ends in several concatenated
9788 suffixes. @code{TEST_EXTENSIONS} defaults to @file{.test}; it can be
9789 overridden by the user, in which case any extension listed in it must be
9790 constituted by a dot, followed by a non-digit alphabetic character,
9791 followed by any number of alphabetic characters.
9792 @c Keep in sync with test-extensions.sh
9793 For example, @samp{.sh}, @samp{.T} and @samp{.t1} are valid extensions,
9794 while @samp{.x-y}, @samp{.6c} and @samp{.t.1} are not.
9796 @cindex Configure substitutions in @code{TESTS}
9797 It is important to note that, due to current limitations (unlikely to be
9798 lifted), configure substitutions in the definition of @code{TESTS} can
9799 only work if they will expand to a list of tests that have a suffix listed
9800 in @code{TEST_EXTENSIONS}.
9802 @vindex _LOG_COMPILE
9803 @vindex _LOG_COMPILER
9806 @vindex LOG_COMPILER
9808 @vindex @var{ext}_LOG_COMPILE
9809 @vindex @var{ext}_LOG_COMPILER
9810 @vindex @var{ext}_LOG_FLAGS
9811 @vindex AM_@var{ext}_LOG_FLAGS
9812 @vindex AM_LOG_FLAGS
9813 For tests that match an extension @code{.@var{ext}} listed in
9814 @code{TEST_EXTENSIONS}, you can provide a custom ``test runner'' using
9815 the variable @code{@var{ext}_LOG_COMPILER} (note the upper-case
9816 extension) and pass options in @code{AM_@var{ext}_LOG_FLAGS} and allow
9817 the user to pass options in @code{@var{ext}_LOG_FLAGS}. It will cause
9818 all tests with this extension to be called with this runner. For all
9819 tests without a registered extension, the variables @code{LOG_COMPILER},
9820 @code{AM_LOG_FLAGS}, and @code{LOG_FLAGS} may be used. For example,
9822 @c Keep in sync with parallel-tests-log-compiler-example.sh
9824 TESTS = foo.pl bar.py baz
9825 TEST_EXTENSIONS = .pl .py
9826 PL_LOG_COMPILER = $(PERL)
9827 AM_PL_LOG_FLAGS = -w
9828 PY_LOG_COMPILER = $(PYTHON)
9829 AM_PY_LOG_FLAGS = -v
9830 LOG_COMPILER = ./wrapper-script
9835 will invoke @samp{$(PERL) -w foo.pl}, @samp{$(PYTHON) -v bar.py},
9836 and @samp{./wrapper-script -d baz} to produce @file{foo.log},
9837 @file{bar.log}, and @file{baz.log}, respectively. The @file{foo.trs},
9838 @file{bar.trs} and @file{baz.trs} files will be automatically produced
9841 It's important to note that, differently from what we've seen for the
9842 serial test harness (@pxref{Serial Test Harness}), the
9843 @code{AM_TESTS_ENVIRONMENT} and @code{TESTS_ENVIRONMENT} variables
9844 @emph{cannot} be used to define a custom test runner; the
9845 @code{LOG_COMPILER} and @code{LOG_FLAGS} (or their extension-specific
9846 counterparts) should be used instead:
9850 AM_TESTS_ENVIRONMENT = PERL5LIB='$(srcdir)/lib' $(PERL) -Mstrict -w
9855 AM_TESTS_ENVIRONMENT = PERL5LIB='$(srcdir)/lib'; export PERL5LIB;
9856 LOG_COMPILER = $(PERL)
9857 AM_LOG_FLAGS = -Mstrict -w
9860 By default, the test suite harness will run all tests, but there are
9861 several ways to limit the set of tests that are run:
9865 You can set the @code{TESTS} variable. For example, you can use a
9866 command like this to run only a subset of the tests:
9869 env TESTS="foo.test bar.test" make -e check
9872 @c https://bugs.gnu.org/42883
9873 If you're using a recursive make setup, you'll probably also need to
9874 override @code{SUBDIRS}:
9877 env TESTS="foo.test bar.test" make -e check SUBDIRS=
9880 Otherwise, the test harness will descend into all subdirectories,
9881 where the tests presumably do not exist, and thus fail. (Patch to
9882 provide better behavior would be welcome.)
9884 Another issue: the command above will unconditionally overwrite the
9885 @file{test-suite.log} file, thus clobbering the recorded results
9886 of any previous testsuite run. This might be undesirable for packages
9887 whose testsuite takes a long time to execute. Luckily, this problem can
9888 easily be avoided by also overriding @code{TEST_SUITE_LOG} at runtime;
9891 @c Keep in sync with parallel-tests-log-override-2.sh
9893 env TEST_SUITE_LOG=partial.log TESTS="..." make -e check
9896 will write the result of the partial testsuite runs to the
9897 @file{partial.log}, without touching @file{test-suite.log}.
9900 You can set the @code{TEST_LOGS} variable. By default, this variable is
9901 computed at @command{make} run time from the value of @code{TESTS} as
9902 described above. For example, you can use the following:
9905 set x subset*.log; shift
9906 env TEST_LOGS="foo.log $*" make -e check
9909 The comments made above about @code{TEST_SUITE_LOG} overriding applies
9913 @vindex RECHECK_LOGS
9914 @cindex lazy test execution
9915 By default, the test harness removes all old per-test @file{.log} and
9916 @file{.trs} files before it starts running tests to regenerate them. The
9917 variable @code{RECHECK_LOGS} contains the set of @file{.log} (and, by
9918 implication, @file{.trs}) files which are removed. @code{RECHECK_LOGS}
9919 defaults to @code{TEST_LOGS}, which means all tests need to be rechecked.
9920 By overriding this variable, you can choose which tests need to be
9921 reconsidered. For example, you can lazily rerun only those tests which
9922 are outdated, i.e., older than their prerequisite test files, by setting
9923 this variable to the empty value:
9926 env RECHECK_LOGS= make -e check
9931 You can ensure that all tests are rerun which have failed or passed
9932 unexpectedly, by running @code{make recheck} in the test directory.
9933 This convenience target will set @code{RECHECK_LOGS} appropriately
9934 before invoking the main test harness.
9938 In order to guarantee an ordering between tests even with @code{make
9939 -j@var{N}}, dependencies between the corresponding @file{.log} files
9940 may be specified through usual @command{make} dependencies. For example,
9941 the following snippet lets the test named @file{foo-execute.test} depend
9942 upon completion of the test @file{foo-compile.test}:
9945 TESTS = foo-compile.test foo-execute.test
9946 foo-execute.log: foo-compile.log
9950 Please note that this ordering ignores the @emph{results} of required
9951 tests, thus the test @file{foo-execute.test} is run even if the test
9952 @file{foo-compile.test} failed or was skipped beforehand. Further,
9953 please note that specifying such dependencies currently works only for
9954 tests that end in one of the suffixes listed in @code{TEST_EXTENSIONS}.
9956 Tests without such specified dependencies may be run concurrently with
9957 parallel @command{make -j@var{N}}, so be sure they are prepared for
9958 concurrent execution.
9961 @c Keep in sync with 'parallel-tests-extra-programs.sh'.
9962 The combination of lazy test execution and correct dependencies between
9963 tests and their sources may be exploited for efficient unit testing
9964 during development. To further speed up the edit-compile-test cycle, it
9965 may even be useful to specify compiled programs in @code{EXTRA_PROGRAMS}
9966 instead of with @code{check_PROGRAMS}, as the former allows intertwined
9967 compilation and test execution (but note that @code{EXTRA_PROGRAMS} are
9968 not cleaned automatically; @pxref{Uniform}).
9970 The variables @code{TESTS} and @code{XFAIL_TESTS} may contain
9971 conditional parts as well as configure substitutions. In the latter
9972 case, however, certain restrictions apply: substituted test names
9973 must end with a nonempty test suffix like @file{.test}, so that one of
9974 the inference rules generated by @command{automake} can apply. For
9975 literal test names, @command{automake} can generate per-target rules
9976 to avoid this limitation.
9978 Please note that it is currently not possible to use @code{$(srcdir)/}
9979 or @code{$(top_srcdir)/} in the @code{TESTS} variable. This technical
9980 limitation is necessary to avoid generating test logs in the source tree
9981 and has the unfortunate consequence that it is not possible to specify
9982 distributed tests that are themselves generated by means of explicit
9983 rules, in a way that is portable to all @command{make} implementations
9984 (@pxref{Make Target Lookup,,, autoconf, The Autoconf Manual}, the
9985 semantics of FreeBSD and OpenBSD @command{make} conflict with this).
9986 In case of doubt you may want to require to use GNU @command{make},
9987 or work around the issue with inference rules to generate the tests.
9989 @node Custom Test Drivers
9990 @section Custom Test Drivers
9993 * Overview of Custom Test Drivers Support::
9994 * Declaring Custom Test Drivers::
9995 * API for Custom Test Drivers::
9998 @node Overview of Custom Test Drivers Support
9999 @subsection Overview of Custom Test Drivers Support
10001 Starting from Automake version 1.12, the parallel test harness allows
10002 the package authors to use third-party custom test drivers, in case the
10003 default ones are inadequate for their purposes, or do not support their
10004 testing protocol of choice.
10006 A custom test driver is expected to properly run the test programs passed
10007 to it (including the command-line arguments passed to those programs, if
10008 any), to analyze their execution and outcome, to create the @file{.log}
10009 and @file{.trs} files associated to these test runs, and to display the test
10010 results on the console. It is responsibility of the author of the test
10011 driver to ensure that it implements all the above steps meaningfully and
10012 correctly; Automake isn't and can't be of any help here. On the other
10013 hand, the Automake-provided code for testsuite summary generation offers
10014 support for test drivers allowing several test results per test script,
10015 if they take care to register such results properly (@pxref{Log files
10016 generation and test results recording}).
10018 The exact details of how test scripts' results are to be determined and
10019 analyzed is left to the individual drivers. Some drivers might only
10020 consider the test script exit status (this is done for example by the
10021 default test driver used by the parallel test harness, described
10022 in the previous section). Other drivers might implement more complex and
10023 advanced test protocols, which might require them to parse and interpret
10024 the output emitted by the test script they're running (examples of such
10025 protocols are TAP and SubUnit).
10027 It's very important to note that, even when using custom test drivers,
10028 most of the infrastructure described in the previous section about the
10029 parallel harness remains in place; this includes:
10033 list of test scripts defined in @code{TESTS}, and overridable at
10034 runtime through the redefinition of @code{TESTS} or @code{TEST_LOGS};
10036 concurrency through the use of @command{make}'s option @option{-j};
10038 per-test @file{.log} and @file{.trs} files, and generation of a summary
10039 @file{.log} file from them;
10041 @code{recheck} target, @code{RECHECK_LOGS} variable, and lazy reruns
10044 inter-test dependencies;
10046 support for @code{check_*} variables (@code{check_PROGRAMS},
10047 @code{check_LIBRARIES}, ...);
10049 use of @code{VERBOSE} environment variable to get verbose output on
10050 testsuite failures;
10052 definition and honoring of @code{TESTS_ENVIRONMENT},
10053 @code{AM_TESTS_ENVIRONMENT} and @code{AM_TESTS_FD_REDIRECT}
10056 definition of generic and extension-specific @code{LOG_COMPILER} and
10057 @code{LOG_FLAGS} variables.
10061 On the other hand, the exact semantics of how (and if) testsuite output
10062 colorization, @code{XFAIL_TESTS}, and hard errors are supported and
10063 handled is left to the individual test drivers.
10065 @c TODO: We should add a working example in the doc/ directory,
10066 @c TODO: and reference it from here.
10068 @node Declaring Custom Test Drivers
10069 @subsection Declaring Custom Test Drivers
10071 @vindex _LOG_DRIVER
10072 @vindex _LOG_DRIVER_FLAGS
10074 @vindex LOG_DRIVER_FLAGS
10075 @vindex @var{ext}_LOG_DRIVER
10076 @vindex @var{ext}_LOG_DRIVER_FLAGS
10077 @vindex AM_@var{ext}_LOG_DRIVER_FLAGS
10078 @vindex AM_LOG_DRIVER_FLAGS
10079 Custom testsuite drivers are declared by defining the make variables
10080 @code{LOG_DRIVER} or @code{@var{ext}_LOG_DRIVER} (where @var{ext} must
10081 be declared in @code{TEST_EXTENSIONS}). They must be defined to
10082 programs or scripts that will be used to drive the execution, logging,
10083 and outcome report of the tests with corresponding extensions (or of
10084 those with no registered extension in the case of @code{LOG_DRIVER}).
10085 Clearly, multiple distinct test drivers can be declared in the same
10086 @file{Makefile.am}. Note moreover that the @code{LOG_DRIVER} variables
10087 are @emph{not} a substitute for the @code{LOG_COMPILER} variables: the
10088 two sets of variables can, and often do, usefully and legitimately
10091 @c TODO: We should point to a clarifying example here!
10093 The developer-reserved variable @code{AM_LOG_DRIVER_FLAGS} and the
10094 user-reserved variable @code{LOG_DRIVER_FLAGS} can be used to define
10095 flags that will be passed to each invocation of @code{LOG_DRIVER},
10096 with the user-defined flags obviously taking precedence over the
10097 developer-reserved ones. Similarly, for each extension @var{ext}
10098 declared in @code{TEST_EXTENSIONS}, flags listed in
10099 @code{AM_@var{ext}_LOG_DRIVER_FLAGS} and
10100 @code{@var{ext}_LOG_DRIVER_FLAGS} will be passed to
10101 invocations of @code{@var{ext}_LOG_DRIVER}.
10103 @node API for Custom Test Drivers
10104 @subsection API for Custom Test Drivers
10106 Note that @emph{the APIs described here are still highly
10107 experimental}, and will very likely undergo tightening and possibly
10108 extensive changes in the future, to accommodate for new features or to
10109 satisfy additional portability requirements.
10111 The main characteristic of these APIs is that they are designed to share
10112 as much infrastructure, semantics, and implementation detail as possible
10113 with the parallel test harness and its default driver.
10116 * Command-line arguments for test drivers::
10117 * Log files generation and test results recording::
10118 * Testsuite progress output::
10121 @node Command-line arguments for test drivers
10122 @subsubsection Command-line arguments for test drivers
10124 A custom driver can rely on various command-line options and arguments
10125 being passed to it automatically by the Automake-generated test harness.
10126 It is @emph{mandatory} that it understands all of them (even if the exact
10127 interpretation of the associated semantics can legitimately change
10128 between a test driver and another, and even be a no-op in some drivers).
10131 Here is the list of options:
10134 @item --test-name=@var{NAME}
10135 The name of the test, with VPATH prefix (if any) removed. This can have a
10136 suffix and a directory component (as in e.g., @file{sub/foo.test}), and is
10137 mostly meant to be used in console reports about testsuite advancements and
10138 results (@pxref{Testsuite progress output}).
10139 @item --log-file=@file{@var{PATH}.log}
10140 The @file{.log} file the test driver must create (@pxref{Basics of
10141 test metadata}). If it has a directory component (as in e.g.,
10142 @file{sub/foo.log}), the test harness will ensure that such directory
10143 exists @emph{before} the test driver is called.
10144 @item --trs-file=@file{@var{PATH}.trs}
10145 The @file{.trs} file the test driver must create (@pxref{Basics of
10146 test metadata}). If it has a directory component (as in e.g.,
10147 @file{sub/foo.trs}), the test harness will ensure that such directory
10148 exists @emph{before} the test driver is called.
10149 @item --color-tests=@{yes|no@}
10150 Whether the console output should be colorized or not (@pxref{Simple
10151 tests and color-tests}, to learn when this option gets activated and
10153 @item --expect-failure=@{yes|no@}
10154 Whether the tested program is expected to fail.
10155 @item --enable-hard-errors=@{yes|no@}
10156 Whether ``hard errors'' in the tested program should be treated differently
10157 from normal failures or not (the default should be @code{yes}). The exact
10158 meaning of ``hard error'' is highly dependent from the test protocols or
10159 conventions in use.
10161 Explicitly terminate the list of options.
10165 The first non-option argument passed to the test driver is the program to
10166 be run, and all the following ones are command-line options and arguments
10169 Note that the exact semantics attached to the @option{--color-tests},
10170 @option{--expect-failure} and @option{--enable-hard-errors} options are
10171 left up to the individual test drivers. Still, having a behaviour
10172 compatible or at least similar to that provided by the default driver
10173 is advised, as that would offer a better consistency and a more pleasant
10176 @node Log files generation and test results recording
10177 @subsubsection Log files generation and test results recording
10179 The test driver must correctly generate the files specified by the
10180 @option{--log-file} and @option{--trs-file} option (even when the tested
10181 program fails or crashes).
10183 The @file{.log} file should ideally contain all the output produced by the
10184 tested program, plus optionally other information that might facilitate
10185 debugging or analysis of bug reports. Apart from that, its format is
10188 The @file{.trs} file is used to register some metadata through the use
10189 of custom reStructuredText fields. This metadata is expected to be
10190 employed in various ways by the parallel test harness; for example, to
10191 count the test results when printing the testsuite summary, or to decide
10192 which tests to rerun upon @command{make recheck}. Unrecognized metadata
10193 in a @file{.trs} file is currently ignored by the harness, but this might
10194 change in the future. The list of currently recognized metadata follows.
10198 @item :test-result:
10199 @cindex Register test result
10200 @cindex Register test case result
10201 @cindex Test result, registering
10202 @cindex Test case result, registering
10203 @cindex @code{:test-result:}
10204 @cindex reStructuredText field, @code{:test-result:}
10205 The test driver must use this field to register the results of @emph{each}
10206 test case run by a test script file. Several @code{:test-result:} fields
10207 can be present in the same @file{.trs} file; this is done in order to
10208 support test protocols that allow a single test script to run more test
10211 @c Keep this in sync with lib/am/check-am:$(TEST_SUITE_LOG).
10212 The only recognized test results are currently @code{PASS}, @code{XFAIL},
10213 @code{SKIP}, @code{FAIL}, @code{XPASS} and @code{ERROR}. These results,
10214 when declared with @code{:test-result:}, can be optionally followed by
10215 text holding the name and/or a brief description of the corresponding
10216 test; the harness will ignore such extra text when generating
10217 @file{test-suite.log} and preparing the testsuite summary.
10219 @c Keep in sync with 'test-metadata-recheck.sh'.
10220 @item @code{:recheck:}
10222 @cindex reStructuredText field, @code{:recheck:}
10223 If this field is present and defined to @code{no}, then the corresponding
10224 test script will @emph{not} be run upon a @command{make recheck}. What
10225 happens when two or more @code{:recheck:} fields are present in the same
10226 @file{.trs} file is undefined behaviour.
10228 @c Keep in sync with 'test-metadata-global-log.sh'.
10229 @item @code{:copy-in-global-log:}
10230 @cindex :copy-in-global-log:
10231 @cindex reStructuredText field, @code{:copy-in-global-log:}
10232 If this field is present and defined to @code{no}, then the content
10233 of the @file{.log} file will @emph{not} be copied into the global
10234 @file{test-suite.log}. We allow to forsake such copying because, while
10235 it can be useful in debugging and analysis of bug report, it can also be
10236 just a waste of space in normal situations, e.g., when a test script is
10237 successful. What happens when two or more @code{:copy-in-global-log:}
10238 fields are present in the same @file{.trs} file is undefined behaviour.
10240 @c Keep in sync with 'test-metadata-global-result.sh'.
10241 @item @code{:test-global-result:}
10242 @cindex :test-global-result:
10243 @cindex reStructuredText field, @code{:test-global-result:}
10244 This is used to declare the "global result" of the script. Currently,
10245 the value of this field is needed only to be reported (more or less
10246 verbatim) in the generated global log file @code{$(TEST_SUITE_LOG)},
10247 so it's quite free-form. For example, a test script which runs 10 test
10248 cases, 6 of which pass and 4 of which are skipped, could reasonably have
10249 a @code{PASS/SKIP} value for this field, while a test script which runs
10250 19 successful tests and one failed test could have an @code{ALMOST
10251 PASSED} value. What happens when two or more @code{:test-global-result:}
10252 fields are present in the same @file{.trs} file is undefined behaviour.
10256 Let's see a small example. Assume a @file{.trs} file contains the
10260 :test-result: PASS server starts
10261 :global-log-copy: no
10262 :test-result: PASS HTTP/1.1 request
10263 :test-result: FAIL HTTP/1.0 request
10265 :test-result: SKIP HTTPS request (TLS library wasn't available)
10266 :test-result: PASS server stops
10270 Then the corresponding test script will be rerun by @command{make check},
10271 will contribute with @emph{five} test results to the testsuite summary
10272 (three of these tests being successful, one failed, and one skipped), and
10273 the content of the corresponding @file{.log} file will @emph{not} be
10274 copied into the global log file @file{test-suite.log}.
10276 @node Testsuite progress output
10277 @subsubsection Testsuite progress output
10279 A custom test driver also has the task of displaying, on the standard
10280 output, the test results as soon as they become available. Depending on
10281 the protocol in use, it can also display the reasons for failures and
10282 skips, and, more generally, any useful diagnostic output (but remember
10283 that each line on the screen is precious, so that cluttering the screen
10284 with overly verbose information is bad idea). The exact format of this
10285 progress output is left up to the test driver; in fact, a custom test
10286 driver might @emph{theoretically} even decide not to do any such report,
10287 leaving it all to the testsuite summary (that would be a very lousy idea,
10288 of course, and serves only to illustrate the flexibility that is
10291 Remember that consistency is good; so, if possible, try to be consistent
10292 with the output of the built-in Automake test drivers, providing a similar
10293 ``look & feel''. In particular, the testsuite progress output should be
10294 colorized when the @option{--color-tests} is passed to the driver. On the
10295 other end, if you are using a known and widespread test protocol with
10296 well-established implementations, being consistent with those
10297 implementations' output might be a good idea too.
10299 @node Using the TAP test protocol
10300 @section Using the TAP test protocol
10303 * Introduction to TAP::
10304 * Use TAP with the Automake test harness::
10305 * Incompatibilities with other TAP parsers and drivers::
10306 * Links and external resources on TAP::
10309 @node Introduction to TAP
10310 @subsection Introduction to TAP
10312 TAP, the Test Anything Protocol, is a simple text-based interface between
10313 testing modules or programs and a test harness. The tests (also called
10314 ``TAP producers'' in this context) write test results in a simple format
10315 on standard output; a test harness (also called ``TAP consumer'') will
10316 parse and interpret these results, and properly present them to the user,
10317 and/or register them for later analysis. The exact details of how this
10318 is accomplished can vary among different test harnesses. The Automake
10319 harness will present the results on the console in the usual
10320 fashion (@pxref{Testsuite progress on console}), and will use the
10321 @file{.trs} files (@pxref{Basics of test metadata}) to store the test
10322 results and related metadata. Apart from that, it will try to remain
10323 as compatible as possible with pre-existing and widespread utilities,
10325 @uref{https://metacpan.org/pod/distribution/Test-Harness/bin/prove,
10326 @command{prove} utility}, at least for the simpler usages.
10328 TAP started its life as part of the test harness for Perl, but today
10329 it has been (mostly) standardized, and has various independent
10330 implementations in different languages; among them, C, C++, Perl,
10331 Python, PHP, and Java. For a semi-official specification of the
10332 TAP protocol, please refer to the documentation of
10333 @uref{https://metacpan.org/pod/Test::Harness, @samp{Test::Harness}}.
10335 The most relevant real-world usages of TAP are obviously in the testsuites
10336 of @command{perl} and of many Perl modules. Still, other important
10337 third-party packages, such as @uref{https://git-scm.com/, @command{git}},
10338 also use TAP in their testsuite.
10340 @node Use TAP with the Automake test harness
10341 @subsection Use TAP with the Automake test harness
10343 Currently, the TAP driver that comes with Automake requires some by-hand
10344 steps on the developer's part (this situation should hopefully be improved
10345 in future Automake versions). You'll have to grab the @file{tap-driver.sh}
10346 script from the Automake distribution by hand, copy it in your source tree,
10347 and use the Automake support for third-party test drivers to instruct the
10348 harness to use the @file{tap-driver.sh} script and the awk program found
10349 by @code{AM_INIT_AUTOMAKE} to run your TAP-producing tests. See the example
10350 below for clarification.
10352 Apart from the options common to all the Automake test drivers
10353 (@pxref{Command-line arguments for test drivers}), @file{tap-driver.sh}
10354 supports the following options, whose names are chosen for enhanced
10355 compatibility with the @command{prove} utility.
10358 @c Keep in sync with 'tap-exit.sh' and 'tap-signal.tap'.
10359 @item --ignore-exit
10360 Causes the test driver to ignore the exit status of the test scripts;
10361 by default, the driver will report an error if the script exits with a
10362 non-zero status. This option has effect also on non-zero exit statuses
10363 due to termination by a signal.
10365 Instruct the test driver to display TAP diagnostics (i.e., lines beginning
10366 with the @samp{#} character) in the testsuite progress output too; by
10367 default, TAP diagnostics are only copied to the @file{.log} file.
10368 @item --no-comments
10369 Revert the effects of @option{--comments}.
10371 Instruct the test driver to merge the test scripts' standard error into
10372 their standard output. This is necessary if you want to ensure that
10373 diagnostics from the test scripts are displayed in the correct order
10374 relative to test results; this can be of great help in debugging
10375 (especially if your test scripts are shell scripts run with shell
10376 tracing active). As a downside, this option might cause the test
10377 harness to get confused if anything that appears on standard error
10378 looks like a test result.
10380 Revert the effects of @option{--merge}.
10381 @item --diagnostic-string=@var{STRING}
10382 Change the string that introduces TAP diagnostics from the default value
10383 of ``@code{#}'' to @code{@var{STRING}}. This can be useful if your
10384 TAP-based test scripts produce verbose output on which they have limited
10385 control (because, say, the output comes from other tools invoked in the
10386 scripts), and it might contain text that gets spuriously interpreted as
10387 TAP diagnostics: such an issue can be solved by redefining the string that
10388 activates TAP diagnostics to a value you know won't appear by chance in
10389 the tests' output. Note however that this feature is non-standard, as
10390 the ``official'' TAP protocol does not allow for such a customization; so
10391 don't use it if you can avoid it.
10395 Here is an example of how the TAP driver can be set up and used.
10397 @c Keep in sync with tap-doc2.sh
10399 % @kbd{cat configure.ac}
10400 AC_INIT([GNU Try Tap], [1.0], [bug-automake@@gnu.org])
10401 AC_CONFIG_AUX_DIR([build-aux])
10402 AM_INIT_AUTOMAKE([foreign -Wall -Werror])
10403 AC_CONFIG_FILES([Makefile])
10404 AC_REQUIRE_AUX_FILE([tap-driver.sh])
10407 % @kbd{cat Makefile.am}
10408 TEST_LOG_DRIVER = env AM_TAP_AWK='$(AWK)' $(SHELL) \
10409 $(top_srcdir)/build-aux/tap-driver.sh
10410 TESTS = foo.test bar.test baz.test
10411 EXTRA_DIST = $(TESTS)
10413 % @kbd{cat foo.test}
10415 echo 1..4 # Number of tests to be executed.
10416 echo 'ok 1 - Swallows fly'
10417 echo 'not ok 2 - Caterpillars fly # TODO metamorphosis in progress'
10418 echo 'ok 3 - Pigs fly # SKIP not enough acid'
10419 echo '# I just love word plays ...'
10420 echo 'ok 4 - Flies fly too :-)'
10422 % @kbd{cat bar.test}
10425 echo 'not ok 1 - Bummer, this test has failed.'
10426 echo 'ok 2 - This passed though.'
10427 echo 'Bail out! Ennui kicking in, sorry...'
10428 echo 'ok 3 - This will not be seen.'
10430 % @kbd{cat baz.test}
10434 # Exit with error, even if all the tests have been successful.
10437 % @kbd{cp @var{PREFIX}/share/automake-@var{APIVERSION}/tap-driver.sh .}
10438 % @kbd{autoreconf -vi && ./configure && make check}
10440 PASS: foo.test 1 - Swallows fly
10441 XFAIL: foo.test 2 - Caterpillars fly # TODO metamorphosis in progress
10442 SKIP: foo.test 3 - Pigs fly # SKIP not enough acid
10443 PASS: foo.test 4 - Flies fly too :-)
10444 FAIL: bar.test 1 - Bummer, this test has failed.
10445 PASS: bar.test 2 - This passed though.
10446 ERROR: bar.test - Bail out! Ennui kicking in, sorry...
10448 ERROR: baz.test - exited with status 7
10450 Please report to bug-automake@@gnu.org
10452 % @kbd{echo exit status: $?}
10455 @c Keep the "skewed" indentation below, it produces pretty PDF output.
10456 % @kbd{env TEST_LOG_DRIVER_FLAGS='--comments --ignore-exit' \
10457 TESTS='foo.test baz.test' make -e check}
10459 PASS: foo.test 1 - Swallows fly
10460 XFAIL: foo.test 2 - Caterpillars fly # TODO metamorphosis in progress
10461 SKIP: foo.test 3 - Pigs fly # SKIP not enough acid
10462 # foo.test: I just love word plays...
10463 PASS: foo.test 4 - Flies fly too :-)
10466 % @kbd{echo exit status: $?}
10470 @node Incompatibilities with other TAP parsers and drivers
10471 @subsection Incompatibilities with other TAP parsers and drivers
10473 For implementation or historical reasons, the TAP driver and harness as
10474 implemented by Automake have some minor incompatibilities with the
10475 mainstream versions, which you should be aware of.
10479 A @code{Bail out!} directive doesn't stop the whole testsuite, but only
10480 the test script it occurs in. This doesn't follow TAP specifications,
10481 but on the other hand it maximizes compatibility (and code sharing) with
10482 the ``hard error'' concept of the default testsuite driver.
10484 The @code{version} and @code{pragma} directives are not supported.
10486 The @option{--diagnostic-string} option of our driver allows modification of
10487 the string that introduces TAP diagnostics from the default value
10488 of ``@code{#}''. The standard TAP protocol currently has no way to
10489 allow this, so if you use it your diagnostic will be lost to more
10490 compliant tools like @command{prove} and @code{Test::Harness}
10492 And there are probably some other small and yet undiscovered
10493 incompatibilities, especially in corner cases or with rare usages.
10496 @node Links and external resources on TAP
10497 @subsection Links and external resources on TAP
10500 Here are some links to more extensive official or third-party
10501 documentation and resources about the TAP protocol and related
10502 tools and libraries.
10505 @uref{https://metacpan.org/pod/Test::Harness, @samp{Test::Harness}},
10506 the (mostly) official documentation about the TAP format and protocol.
10508 @uref{https://metacpan.org/pod/distribution/Test-Harness/bin/prove,
10510 the most famous command-line TAP test driver, included in the distribution
10511 of @command{perl} and
10512 @uref{https://metacpan.org/pod/distribution/Test-Harness/lib/Test/Harness.pm,
10513 @samp{Test::Harness}}.
10515 The @uref{https://testanything.org/,TAP wiki}.
10517 A ``gentle introduction'' to testing for Perl coders:
10518 @uref{https://metacpan.org/pod/distribution/Test-Simple/lib/Test/Tutorial.pod,
10519 @samp{Test::Tutorial}}.
10521 @uref{https://metacpan.org/pod/distribution/Test-Simple/lib/Test/Simple.pm,
10522 @samp{Test::Simple}}
10524 @uref{https://metacpan.org/pod/distribution/Test-Simple/lib/Test/More.pm,
10525 @samp{Test::More}},
10526 the standard Perl testing libraries, which are based on TAP.
10528 @uref{https://www.eyrie.org/~eagle/software/c-tap-harness/,C TAP Harness},
10529 a C-based project implementing both a TAP producer and a TAP consumer.
10531 @uref{https://tap4j.org/,tap4j},
10532 a Java-based project implementing both a TAP producer and a TAP consumer.
10535 @node DejaGnu Tests
10536 @section DejaGnu Tests
10538 If @command{dejagnu} (@pxref{Top, , Introduction, dejagnu, DejaGnu})
10539 appears in @code{AUTOMAKE_OPTIONS}, then a @command{dejagnu}-based
10540 test suite is assumed. The variable @code{DEJATOOL} is a list of
10541 names that are passed, one at a time, as the @option{--tool} argument
10542 to @command{runtest} invocations; it defaults to the name of the
10545 The variable @code{RUNTESTDEFAULTFLAGS} holds the @option{--tool} and
10546 @option{--srcdir} flags that are passed to dejagnu by default; this can be
10547 overridden if necessary.
10548 @vindex RUNTESTDEFAULTFLAGS
10550 The variables @code{EXPECT} and @code{RUNTEST} can
10551 also be overridden to provide project-specific values. For instance,
10552 you will need to do this if you are testing a compiler toolchain,
10553 because the default values do not take into account host and target
10560 The contents of the variable @code{RUNTESTFLAGS} are passed to the
10561 @code{runtest} invocation. This is considered a ``user variable''
10562 (@pxref{User Variables}). If you need to set @command{runtest} flags in
10563 @file{Makefile.am}, you can use @code{AM_RUNTESTFLAGS} instead.
10564 @vindex RUNTESTFLAGS
10565 @vindex AM_RUNTESTFLAGS
10567 @cindex @file{site.exp}
10568 Automake will generate rules to create a local @file{site.exp} file,
10569 defining various variables detected by @command{configure}. This file
10570 is automatically read by DejaGnu. It is OK for the user of a package
10571 to edit this file in order to tune the test suite. However this is
10572 not the place where the test suite author should define new variables:
10573 this should be done elsewhere in the real test suite code.
10574 Especially, @file{site.exp} should not be distributed.
10576 Still, if the package author has legitimate reasons to extend
10577 @file{site.exp} at @command{make} time, he can do so by defining
10578 the variable @code{EXTRA_DEJAGNU_SITE_CONFIG}; the files listed
10579 there will be considered @file{site.exp} prerequisites, and their
10580 content will be appended to it (in the same order in which they
10581 appear in @code{EXTRA_DEJAGNU_SITE_CONFIG}). Note that files are
10582 @emph{not} distributed by default.
10584 For more information regarding DejaGnu test suites, see @ref{Top, , ,
10585 dejagnu, The DejaGnu Manual}.
10587 @node Install Tests
10588 @section Install Tests
10590 The @code{installcheck} target is available to the user as a way to
10591 run any tests after the package has been installed. You can add tests
10592 to this by writing an @code{installcheck-local} rule.
10596 @chapter Rebuilding Makefiles
10597 @cindex rebuild rules
10599 Automake generates rules to automatically rebuild @file{Makefile}s,
10600 @file{configure}, and other derived files like @file{Makefile.in}.
10602 @acindex AM_MAINTAINER_MODE
10603 If you are using @code{AM_MAINTAINER_MODE} in @file{configure.ac}, then
10604 these automatic rebuilding rules are only enabled in maintainer mode.
10606 @vindex CONFIG_STATUS_DEPENDENCIES
10607 @vindex CONFIGURE_DEPENDENCIES
10608 @cindex @file{version.sh}, example
10609 @cindex @file{version.m4}, example
10611 Sometimes it is convenient to supplement the rebuild rules for
10612 @file{configure} or @file{config.status} with additional dependencies.
10613 The variables @code{CONFIGURE_DEPENDENCIES} and
10614 @code{CONFIG_STATUS_DEPENDENCIES} can be used to list these extra
10615 dependencies. These variables should be defined in all
10616 @file{Makefile}s of the tree (because these two rebuild rules are
10617 output in all of them), so it is safer and easier to @code{AC_SUBST} them
10618 from @file{configure.ac}. For instance, the following statement will
10619 cause @file{configure} to be rerun each time @file{version.sh} is
10622 @c Keep in sync with remake-config-status-dependencies.sh
10624 AC_SUBST([CONFIG_STATUS_DEPENDENCIES], ['$(top_srcdir)/version.sh'])
10628 Note the @samp{$(top_srcdir)/} in the file name. Since this variable
10629 is to be used in all @file{Makefile}s, its value must be sensible at
10630 any level in the build hierarchy.
10632 Beware not to mistake @code{CONFIGURE_DEPENDENCIES} for
10633 @code{CONFIG_STATUS_DEPENDENCIES}.
10635 @c Keep in sync with remake-configure-dependencies.sh
10636 @code{CONFIGURE_DEPENDENCIES} adds dependencies to the
10637 @file{configure} rule, whose effect is to run @command{autoconf}. This
10638 variable should be seldom used, because @command{automake} already tracks
10639 @code{m4_include}d files. However it can be useful when playing
10640 tricky games with @code{m4_esyscmd} or similar non-recommendable
10641 macros with side effects. Be also aware that interactions of this
10642 variable with the @ref{Autom4te Cache, , autom4te cache, autoconf,
10643 The Autoconf Manual} are quite problematic and can cause subtle
10644 breakage, so you might want to disable the cache if you want to use
10645 @code{CONFIGURE_DEPENDENCIES}.
10647 @code{CONFIG_STATUS_DEPENDENCIES} adds dependencies to the
10648 @file{config.status} rule, whose effect is to run @file{configure}.
10649 This variable should therefore carry any non-standard source that may
10650 be read as a side effect of running @command{configure}, like @file{version.sh}
10651 in the example above.
10653 Speaking of @file{version.sh} scripts, we recommend against them
10654 today. They are mainly used when the version of a package is updated
10655 automatically by a script (e.g., in daily builds). Here is what some
10656 old-style @file{configure.ac}s may look like:
10660 . $srcdir/version.sh
10661 AM_INIT_AUTOMAKE([name], $VERSION_NUMBER)
10666 Here, @file{version.sh} is a shell fragment that sets
10667 @code{VERSION_NUMBER}. The problem with this example is that
10668 @command{automake} cannot track dependencies (listing @file{version.sh}
10669 in @command{CONFIG_STATUS_DEPENDENCIES}, and distributing this file is up
10670 to the user), and that it uses the obsolete form of @code{AC_INIT} and
10671 @code{AM_INIT_AUTOMAKE}. Upgrading to the new syntax is not
10672 straightforward, because shell variables are not allowed in
10673 @code{AC_INIT}'s arguments. We recommend that @file{version.sh} be
10674 replaced by an M4 file that is included by @file{configure.ac}:
10677 m4_include([version.m4])
10678 AC_INIT([name], VERSION_NUMBER)
10684 Here @file{version.m4} could contain something like
10685 @samp{m4_define([VERSION_NUMBER], [1.2])}. The advantage of this
10686 second form is that @command{automake} will take care of the
10687 dependencies when defining the rebuild rule, and will also distribute
10688 the file automatically. An inconvenience is that @command{autoconf}
10689 will now be rerun each time the version number is bumped, when only
10690 @file{configure} had to be rerun in the previous setup.
10692 @opindex --always-make @r{GNU Make option}
10693 GNU Make, at least, has an option @option{--always-make} which tells
10694 Make to consider that all targets are out of date. This interacts
10695 badly with Automake-generated Makefiles, which implement their own
10696 careful rules for when to regenerate Makefiles, as described above.
10697 The result is an endless loop, or other poor behavior. The only thing
10698 to do, as far as we know, is to refrain from using
10699 @option{--always-make}.
10703 @chapter Changing Automake's Behavior
10706 * Options generalities:: Semantics of Automake option
10707 * List of Automake options:: A comprehensive list of Automake options
10710 @node Options generalities
10711 @section Options generalities
10713 Various features of Automake can be controlled by options. Except where
10714 noted otherwise, options can be specified in one of several ways. Most
10715 options can be applied on a per-@file{Makefile} basis when listed in a
10716 special @file{Makefile} variable named @code{AUTOMAKE_OPTIONS}. Some
10717 of these options only make sense when specified in the toplevel
10718 @file{Makefile.am} file. Options are applied globally to all processed
10719 @file{Makefile} files when listed in the first argument of
10720 @code{AM_INIT_AUTOMAKE} in @file{configure.ac}, and some options which
10721 require changes to the @command{configure} script can only be specified
10722 there. These are annotated below.
10724 As a general rule, options specified in @code{AUTOMAKE_OPTIONS} take
10725 precedence over those specified in @code{AM_INIT_AUTOMAKE}, which in
10726 turn take precedence over those specified on the command line.
10728 Also, some care must be taken about the interactions among strictness
10729 level and warning categories. As a general rule, strictness-implied
10730 warnings are overridden by those specified by explicit options. For
10731 example, even if @samp{portability} warnings are disabled by default
10732 in @option{foreign} strictness, a usage like this will end up enabling
10736 AUTOMAKE_OPTIONS = -Wportability foreign
10739 However, a strictness level specified in a higher-priority context
10740 will override all the explicit warnings specified in a lower-priority
10741 context. For example, if @file{configure.ac} contains:
10744 AM_INIT_AUTOMAKE([-Wportability])
10748 and @file{Makefile.am} contains:
10751 AUTOMAKE_OPTIONS = foreign
10755 then @samp{portability} warnings will be @emph{disabled} in
10756 @file{Makefile.am}.
10758 @node List of Automake options
10759 @section List of Automake options
10761 @vindex AUTOMAKE_OPTIONS
10764 @item @option{gnits}
10765 @itemx @option{gnu}
10766 @itemx @option{foreign}
10767 @cindex Option, @option{gnits}
10768 @cindex Option, @option{gnu}
10769 @cindex Option, @option{foreign}
10774 Set the strictness as appropriate. @xref{Strictness}.
10775 The @option{gnits} option also implies options @option{readme-alpha} and
10776 @option{check-news}.
10778 @item @option{check-news}
10779 @cindex Option, @option{check-news}
10780 @opindex check-news
10781 Cause @samp{make dist} to fail unless the current version number appears
10782 in the first few lines of the @file{NEWS} file.
10784 @item @option{dejagnu}
10785 @cindex Option, @option{dejagnu}
10787 Cause @command{dejagnu}-specific rules to be generated. @xref{DejaGnu Tests}.
10789 @item @option{dist-bzip2}
10790 @cindex Option, @option{dist-bzip2}
10791 @opindex dist-bzip2
10792 Hook @code{dist-bzip2} to @code{dist}.
10793 @trindex dist-bzip2
10795 @item @option{dist-lzip}
10796 @cindex Option, @option{dist-lzip}
10798 Hook @code{dist-lzip} to @code{dist}.
10801 @item @option{dist-xz}
10802 @cindex Option, @option{dist-xz}
10804 Hook @code{dist-xz} to @code{dist}.
10807 @item @option{dist-zip}
10808 @cindex Option, @option{dist-zip}
10810 Hook @code{dist-zip} to @code{dist}.
10813 @item @option{dist-zstd}
10814 @cindex Option, @option{dist-zstd}
10816 Hook @code{dist-zstd} to @code{dist}.
10819 @item @option{dist-shar}
10820 @cindex Option, @option{dist-shar}
10822 Hook @code{dist-shar} to @code{dist}. Use of this option
10823 is deprecated, as the @samp{shar} format is obsolescent and
10824 problematic. Support for it will be removed altogether in
10828 @item @option{dist-tarZ}
10829 @cindex Option, @option{dist-tarZ}
10831 Hook @code{dist-tarZ} to @code{dist}. Use of this option
10832 is deprecated, as the @samp{compress} program is obsolete.
10833 Support for it will be removed altogether in Automake 2.0.
10836 @item @option{filename-length-max=99}
10837 @cindex Option, @option{filename-length-max=99}
10838 @opindex filename-length-max=99
10839 Abort if file names longer than 99 characters are found during
10840 @samp{make dist}. Such long file names are generally considered not to
10841 be portable in tarballs. See the @option{tar-v7} and @option{tar-ustar}
10842 options below. This option should be used in the top-level
10843 @file{Makefile.am} or as an argument of @code{AM_INIT_AUTOMAKE} in
10844 @file{configure.ac}; it will be ignored otherwise. It will also be
10845 ignored in sub-packages of nested packages (@pxref{Subpackages}).
10847 @item @option{info-in-builddir}
10848 @cindex Option, @option{info-in-builddir}
10849 @opindex info-in-builddir
10850 Instruct Automake to place the generated @file{.info} files in the
10851 @code{builddir} rather than in the @code{srcdir}. Note that this
10852 might make VPATH builds with some non-GNU make implementations more
10855 @item @option{no-define}
10856 @cindex Option, @option{no-define}
10858 This option is meaningful only when passed as an argument to
10859 @code{AM_INIT_AUTOMAKE}. It will prevent the @code{PACKAGE} and
10860 @code{VERSION} variables from being @code{AC_DEFINE}d. But notice
10861 that they will remain defined as shell variables in the generated
10862 @code{configure}, and as make variables in the generated
10863 @code{Makefile}; this is deliberate, and required for backward
10866 @item @option{no-dependencies}
10867 @cindex Option, @option{no-dependencies}
10868 @opindex no-dependencies
10869 This is similar to using @option{--ignore-deps} on the command line,
10870 but is useful for those situations where you don't have the necessary
10871 bits to make automatic dependency tracking work
10872 (@pxref{Dependencies}). In this case the effect is to effectively
10873 disable automatic dependency tracking.
10875 @item @option{no-dist}
10876 @cindex Option, @option{no-dist}
10878 Don't emit any code related to @code{dist} target. This is useful
10879 when a package has its own method for making distributions.
10881 @item @option{no-dist-built-sources}
10882 @cindex Option, @option{no-dist-built-sources}
10883 @opindex no-dist-built-sources
10884 @cindex @command{help2man}, and @samp{dist} target
10885 @vindex BUILT_SOURCES, and @samp{dist} target
10886 Don't build @code{BUILT_SOURCES} as part of @code{dist}. This option
10887 can be set if building the distribution only requires the source
10888 files, and doesn't compile anything as a side-effect. The default is
10889 for @samp{$(distdir)} to depend on @samp{$(BUILT_SOURCES)} because it
10890 is common, at least among GNU packages, to want to build the program
10891 to generate man pages with @code{help2man} (@pxref{Errors with
10892 distclean}). Admittedly the default behavior should perhaps be to
10893 omit the dependency, but to preserve compatibility, we don't want to
10896 @item @option{no-dist-gzip}
10897 @cindex Option, @option{no-dist-gzip}
10898 @opindex no-dist-gzip
10899 Do not hook @code{dist-gzip} to @code{dist}.
10900 @trindex no-dist-gzip
10902 @item @option{no-exeext}
10903 @cindex Option, @option{no-exeext}
10905 If your @file{Makefile.am} defines a rule for target @code{foo}, it
10906 will override a rule for a target named @samp{foo$(EXEEXT)}. This is
10907 necessary when @code{EXEEXT} is found to be empty. However, by
10908 default @command{automake} will generate an error for this use. The
10909 @option{no-exeext} option will disable this error. This is intended for
10910 use only where it is known in advance that the package will not be
10911 ported to Windows, or any other operating system using extensions on
10914 @item @option{no-installinfo}
10915 @cindex Option, @option{no-installinfo}
10916 @opindex no-installinfo
10917 The generated @file{Makefile.in} will not cause info pages to be built
10918 or installed by default. However, @code{info} and @code{install-info}
10919 targets will still be available. This option is disallowed at
10920 @option{gnu} strictness and above.
10922 @trindex install-info
10924 @item @option{no-installman}
10925 @cindex Option, @option{no-installman}
10926 @opindex no-installman
10927 The generated @file{Makefile.in} will not cause man pages to be
10928 installed by default. However, an @code{install-man} target will still
10929 be available for optional installation. This option is disallowed at
10930 @option{gnu} strictness and above.
10931 @trindex install-man
10933 @item @option{nostdinc}
10934 @cindex Option, @option{nostdinc}
10936 This option can be used to disable the standard @option{-I} options that
10937 are ordinarily automatically provided by Automake.
10939 @item @option{no-texinfo.tex}
10940 @cindex Option, @option{no-texinfo.tex}
10941 @opindex no-texinfo.tex
10942 Don't require @file{texinfo.tex}, even if there are texinfo files in
10945 @item @option{posix}
10946 @cindex Option, @option{posix}
10948 Generate the special target @code{.POSIX} as the first non-comment
10949 line in the @file{Makefile.in} files. This alters the behavior of the
10950 @code{make} program. @xref{Special targets,, make, The GNU Make
10953 @item @option{serial-tests}
10954 @cindex Option, @option{serial-tests}
10955 @opindex serial-tests
10956 Enable the older serial test suite harness for @code{TESTS} (@pxref{Serial
10957 Test Harness}, for more information).
10959 @item @option{parallel-tests}
10960 @cindex Option, @option{parallel-tests}
10961 @opindex parallel-tests
10962 Enable test suite harness for @code{TESTS} that can run tests in parallel
10963 (@pxref{Parallel Test Harness}, for more information). This option is
10964 only kept for backward-compatibility, since the parallel test harness is
10967 @item @option{readme-alpha}
10968 @cindex Option, @option{readme-alpha}
10969 @opindex readme-alpha
10970 If this release is an alpha release, and the file @file{README-alpha}
10971 exists, then it will be added to the distribution. If this option is
10972 given, version numbers are expected to follow one of two forms. The
10973 first form is @samp{@var{major}.@var{minor}.@var{alpha}}, where each
10974 element is a number; the final period and number should be left off for
10975 non-alpha releases. The second form is
10976 @samp{@var{major}.@var{minor}@var{alpha}}, where @var{alpha} is a
10977 letter; it should be omitted for non-alpha releases.
10979 @item @option{std-options}
10980 @cindex Options, @option{std-options}
10981 @cindex @samp{make installcheck}, testing @option{--help} and @option{--version}
10982 @cindex @option{--help} check
10983 @cindex @option{--version} check
10984 @opindex std-options
10986 Make the @code{installcheck} rule check that installed scripts and
10987 programs support the @option{--help} and @option{--version} options.
10988 This also provides a basic check that the program's
10989 run-time dependencies are satisfied after installation.
10991 @vindex AM_INSTALLCHECK_STD_OPTIONS_EXEMPT
10992 In a few situations, programs (or scripts) have to be exempted from this
10993 test. For instance, @command{false} (from GNU coreutils) is never
10994 successful, even for @option{--help} or @option{--version}. You can list
10995 such programs in the variable @code{AM_INSTALLCHECK_STD_OPTIONS_EXEMPT}.
10996 Programs (not scripts) listed in this variable should be suffixed by
10997 @samp{$(EXEEXT)} for the sake of Windows or OS/2. For instance, suppose we
10998 build @file{false} as a program but @file{true.sh} as a script, and that
10999 neither of them support @option{--help} or @option{--version}:
11002 AUTOMAKE_OPTIONS = std-options
11003 bin_PROGRAMS = false ...
11004 bin_SCRIPTS = true.sh ...
11005 AM_INSTALLCHECK_STD_OPTIONS_EXEMPT = false$(EXEEXT) true.sh
11008 @item @option{subdir-objects}
11009 @cindex Options, @option{subdir-objects}
11010 @opindex subdir-objects
11011 If this option is specified, then objects are placed into the
11012 subdirectory of the build directory corresponding to the subdirectory of
11013 the source file. For instance, if the source file is
11014 @file{subdir/file.cxx}, then the output file would be
11015 @file{subdir/file.o}. @xref{Program and Library Variables}.
11017 @anchor{tar-formats}
11018 @item @option{tar-v7}
11019 @itemx @option{tar-ustar}
11020 @itemx @option{tar-pax}
11021 @cindex Option, @option{tar-v7}
11022 @cindex Option, @option{tar-ustar}
11023 @cindex Option, @option{tar-pax}
11024 @cindex @command{tar} formats
11025 @cindex v7 @command{tar} format
11026 @cindex ustar format
11032 These three mutually exclusive options select the tar format to use
11033 when generating tarballs with @samp{make dist}. (The tar file created
11034 is then compressed according to the set of @option{no-dist-gzip},
11035 @option{dist-bzip2}, @option{dist-lzip}, @option{dist-xz},
11036 @option{dist-zstd} and @option{dist-tarZ} options in use.)
11038 These options must be passed as arguments to @code{AM_INIT_AUTOMAKE}
11039 (@pxref{Macros}) because they can require additional configure checks.
11040 Automake will complain if it sees such options in an
11041 @code{AUTOMAKE_OPTIONS} variable.
11043 @option{tar-v7} selects the old V7 tar format. This is the historical
11044 default. This antiquated format is understood by all tar
11045 implementations and supports file names with up to 99 characters. When
11046 given longer file names some tar implementations will diagnose the
11047 problem while others will generate broken tarballs or use non-portable
11048 extensions. Furthermore, the V7 format cannot store empty
11049 directories. When using this format, consider using the
11050 @option{filename-length-max=99} option to catch file names too long.
11052 @option{tar-ustar} selects the ustar format defined by POSIX
11053 1003.1-1988. This format is old enough to be portable:
11054 As of 2018, it is supported by the native @code{tar} command on
11055 GNU, FreeBSD, NetBSD, OpenBSD, AIX, HP-UX, and Solaris, at least.
11056 It fully supports empty directories. It can store file names with up
11057 to 256 characters, provided that the file name can be split at
11058 directory separator in two parts, first of them being at most 155
11059 bytes long. So, in most cases the maximum file name length will be
11060 shorter than 256 characters.
11062 @option{tar-pax} selects the new pax interchange format defined by POSIX
11063 1003.1-2001. It does not limit the length of file names. However,
11064 this format is very young and should probably be restricted to
11065 packages that target only very modern platforms.
11066 As of 2018, this format is supported by the native @code{tar} command only
11067 on GNU, FreeBSD, and OpenBSD systems; it is not supported by the native
11068 @code{tar} command on NetBSD, AIX, HP-UX, or Solaris.
11070 change the pax format in an upward-compatible way, so this option may
11071 refer to a more recent version in the future.
11073 @xref{Formats, , Controlling the Archive Format, tar, GNU Tar}, for
11074 further discussion about tar formats.
11076 @command{configure} knows several ways to construct these formats. It
11077 will not abort if it cannot find a tool up to the task (so that the
11078 package can still be built), but @samp{make dist} will fail.
11080 @item @var{version}
11081 @cindex Option, @var{version}
11082 A version number (e.g., @samp{0.30}) can be specified. If Automake is not
11083 the same version or
11084 newer than the version specified, creation of the @file{Makefile.in}
11085 will be suppressed.
11087 @item @option{-W@var{category}} or @option{--warnings=@var{category}}
11088 @cindex Option, warnings
11089 @cindex Option, @option{-W@var{category}}
11090 @cindex Option, @option{--warnings=@var{category}}
11091 These options behave exactly like their command-line counterpart
11092 (@pxref{automake Invocation}). This allows you to enable or disable some
11093 warning categories on a per-file basis. You can also setup some warnings
11094 for your entire project; for instance, try @samp{AM_INIT_AUTOMAKE([-Wall])}
11095 in your @file{configure.ac}.
11099 Unrecognized options are diagnosed by @command{automake}.
11101 If you want an option to apply to all the files in the tree, you can use
11102 the @code{AM_INIT_AUTOMAKE} macro in @file{configure.ac}.
11106 @node Miscellaneous
11107 @chapter Miscellaneous Rules
11109 There are a few rules and variables that didn't fit anywhere else.
11112 * Tags:: Interfacing to cscope, etags and mkid
11113 * Suffixes:: Handling new file extensions
11118 @section Interfacing to @command{etags}
11120 @cindex @file{TAGS} support
11122 Automake will generate rules to generate @file{TAGS} files for use with
11123 GNU Emacs under some circumstances.
11126 If any C, C++ or Fortran 77 source code or headers are present, then
11127 @code{tags} and @code{TAGS} rules will be generated for the directory.
11128 All files listed using the @code{_SOURCES}, @code{_HEADERS}, and
11129 @code{_LISP} primaries will be used to generate tags. Generated
11130 source files that are not distributed must be declared in variables
11131 like @code{nodist_noinst_HEADERS} or @code{nodist_@var{prog}_SOURCES}
11132 or they will be ignored.
11134 A @code{tags} rule will be output at the topmost directory of a
11135 multi-directory package. When run from this topmost directory,
11136 @samp{make tags} will generate a @file{TAGS} file that includes by
11137 reference all @file{TAGS} files from subdirectories.
11139 The @code{tags} rule will also be generated if the variable
11140 @code{ETAGS_ARGS} is defined. This variable is intended for use in
11141 directories that contain taggable source that @command{etags} does
11142 not understand. The user can use the @code{ETAGSFLAGS} to pass
11143 additional flags to @command{etags}; @code{AM_ETAGSFLAGS} is also
11144 available for use in @file{Makefile.am}. The variable @code{ETAGS}
11145 is the name of the program to invoke (by default @command{etags}).
11148 @vindex AM_ETAGSFLAGS
11151 Here is how Automake generates tags for its source, and for nodes in its
11155 ETAGS_ARGS = automake.in --lang=none \
11156 --regex='/^@@node[ \t]+\([^,]+\)/\1/' automake.texi
11159 If you add file names to @code{ETAGS_ARGS}, you will probably also
11160 want to define @code{TAGS_DEPENDENCIES}. The contents of this variable
11161 are added directly to the dependencies for the @code{tags} rule.
11162 @vindex TAGS_DEPENDENCIES
11164 Automake also generates a @code{ctags} rule that can be used to
11165 build @command{vi}-style @file{tags} files. The variable @code{CTAGS}
11166 is the name of the program to invoke (by default @command{ctags});
11167 @code{CTAGSFLAGS} can be used by the user to pass additional flags,
11168 and @code{AM_CTAGSFLAGS} can be used by the @file{Makefile.am}.
11174 Automake will also generate an @code{ID} rule that will run
11175 @command{mkid} on the source. This is only supported on a
11176 directory-by-directory basis.
11178 Similarly, the @code{cscope} rule will create a list of all the source
11179 files in the tree and run @command{cscope} to build an inverted index
11180 database. The variable @code{CSCOPE} is the name of the program to invoke
11181 (by default @command{cscope}); @code{CSCOPEFLAGS} and
11182 @code{CSCOPE_ARGS} can be used by the user to pass additional flags and
11183 file names respectively, while @code{AM_CSCOPEFLAGS} can be used by the
11184 @file{Makefile.am}. Note that, currently, the Automake-provided
11185 @code{cscope} support, when used in a VPATH build, might not work well
11186 with non-GNU make implementations (especially with make implementations
11187 performing @ref{Automatic Rule Rewriting, , VPATH rewrites, autoconf,
11188 The Autoconf Manual}).
11189 @vindex CSCOPE_ARGS
11190 @vindex CSCOPEFLAGS
11193 Finally, Automake also emits rules to support the
11194 @uref{https://www.gnu.org/software/global/, GNU Global Tags program}.
11195 The @code{GTAGS} rule runs Global Tags and puts the
11196 result in the top build directory. The variable @code{GTAGS_ARGS}
11197 holds arguments that are passed to @command{gtags}.
11202 @section Handling new file extensions
11204 @cindex Adding new @code{SUFFIXES}
11205 @cindex @code{SUFFIXES}, adding
11208 It is sometimes useful to introduce a new implicit rule to handle a file
11209 type that Automake does not know about.
11211 For instance, suppose you had a compiler that could compile @file{.foo}
11212 files to @file{.o} files. You would simply define a suffix rule for
11220 Then you could directly use a @file{.foo} file in a @code{_SOURCES}
11221 variable and expect the correct results:
11224 bin_PROGRAMS = doit
11225 doit_SOURCES = doit.foo
11228 This was the simpler and more common case. In other cases, you will
11229 have to help Automake to figure out which extensions you are defining your
11230 suffix rule for. This usually happens when your extension does not
11231 start with a dot. Then, all you have to do is to put a list of new
11232 suffixes in the @code{SUFFIXES} variable @strong{before} you define your
11235 For instance, the following definition prevents Automake from misinterpreting
11236 the @samp{.idlC.cpp:} rule as an attempt to transform @file{.idlC} files into
11239 @c Keep in sync with suffix7.sh
11241 SUFFIXES = .idl C.cpp
11246 As you may have noted, the @code{SUFFIXES} variable behaves like the
11247 @code{.SUFFIXES} special target of @command{make}. You should not touch
11248 @code{.SUFFIXES} yourself, but use @code{SUFFIXES} instead and let
11249 Automake generate the suffix list for @code{.SUFFIXES}. Any given
11250 @code{SUFFIXES} go at the start of the generated suffixes list, followed
11251 by Automake generated suffixes not already in the list.
11253 @c https://bugs.gnu.org/64743.
11254 @cindex built-in suffix and pattern rules, disabled
11255 @cindex suffix rules of Make, disabled
11256 @cindex pattern rules of GNU Make, disabled
11257 Automake disables the Make program's built-in rules with a
11258 @code{.SUFFIXES:} rule, and then adds whatever suffixes are
11259 necessary. Automake also disables GNU Make's built-in pattern rules.
11265 @cindex Including @file{Makefile} fragment
11266 @cindex @file{Makefile} fragment, including
11268 Automake supports an @code{include} directive that can be used to
11269 include other @file{Makefile} fragments when @command{automake} is run.
11270 Note that these fragments are read and interpreted by @command{automake},
11271 not by @command{make}. As with conditionals, @command{make} has no idea that
11272 @code{include} is in use.
11274 There are two forms of @code{include}:
11277 @item include $(srcdir)/file
11278 Include a fragment that is found relative to the current source
11281 @item include $(top_srcdir)/file
11282 Include a fragment that is found relative to the top source directory.
11285 Note that if a fragment is included inside a conditional, then the
11286 condition applies to the entire contents of that fragment.
11288 @file{Makefile} fragments included this way are always distributed because
11289 they are needed to rebuild @file{Makefile.in}.
11291 Inside a fragment, the construct @code{%reldir%} is replaced with the
11292 directory of the fragment relative to the base @file{Makefile.am}.
11293 Similarly, @code{%canon_reldir%} is replaced with the canonicalized
11294 (@pxref{Canonicalization}) form of @code{%reldir%}. As a convenience,
11295 @code{%D%} is a synonym for @code{%reldir%}, and @code{%C%}
11296 is a synonym for @code{%canon_reldir%}.
11298 A special feature is that if the fragment is in the same directory as
11299 the base @file{Makefile.am} (i.e., @code{%reldir%} is @code{.}), then:
11303 together with a following slash expands to the empty string, otherwise
11304 it expands to a dot;
11306 @item %canon_reldir%
11307 together with a following underscore expands to the empty string, otherwise
11308 it expands to an underscore.
11312 Thus, a @file{Makefile} fragment might look like this:
11315 bin_PROGRAMS += %reldir%/mumble
11316 %canon_reldir%_mumble_SOURCES = %reldir%/one.c
11320 @chapter Conditionals
11322 @cindex Conditionals
11324 Automake supports a simple type of conditional.
11326 These conditionals are not the same as conditionals in
11327 GNU Make. Automake conditionals are checked at configure time by the
11328 @file{configure} script, and affect the translation from
11329 @file{Makefile.in} to @file{Makefile}. They are based on options passed
11330 to @file{configure} and on results that @file{configure} has discovered
11331 about the host system. GNU Make conditionals are checked at @command{make}
11332 time, and are based on variables passed to the make program or defined
11333 in the @file{Makefile}.
11335 Automake conditionals will work with any make program.
11338 * Usage of Conditionals:: Declaring conditional content
11339 * Limits of Conditionals:: Enclosing complete statements
11342 @node Usage of Conditionals
11343 @section Usage of Conditionals
11345 @acindex AM_CONDITIONAL
11346 Before using a conditional, you must define it by using
11347 @code{AM_CONDITIONAL} in the @file{configure.ac} file (@pxref{Macros}).
11349 @defmac AM_CONDITIONAL (@var{conditional}, @var{condition})
11350 The conditional name, @var{conditional}, should be a simple string
11351 starting with a letter and containing only letters, digits, and
11352 underscores. It must be different from @samp{TRUE} and @samp{FALSE},
11353 which are reserved by Automake.
11355 The shell @var{condition} (suitable for use in a shell @code{if}
11356 statement) is evaluated when @command{configure} is run. Note that you
11357 must arrange for @emph{every} @code{AM_CONDITIONAL} to be invoked every
11358 time @command{configure} is run. If @code{AM_CONDITIONAL} is run
11359 conditionally (e.g., in a shell @code{if} statement), then the result
11360 will confuse @command{automake}.
11362 For portability, it is best to use shell operators @code{&&} and
11363 @code{||} and parentheses, when constructing a compound
11364 @var{condition} using the @command{test} command, and not the
11365 @code{-a} and @code{-o} options and parentheses as options to
11366 @command{test}, all of which have been marked obsolescent by POSIX
11367 (@url{https://pubs.opengroup.org/onlinepubs/9699919799/utilities/test.html#tag_20_128_161}).
11368 The name @code{test} is also more portable than @code{[}.
11369 @xref{Limitations of Builtins, ,, autoconf, The Autoconf Manual}.
11373 @cindex @option{--enable-debug}, example
11374 @cindex Example conditional @option{--enable-debug}
11375 @cindex Conditional example, @option{--enable-debug}
11377 Conditionals typically depend upon options that the user provides to
11378 the @command{configure} script. Here is an example of how to write a
11379 conditional that is true if the user uses the @option{--enable-debug}
11383 AC_ARG_ENABLE([debug],
11384 [ --enable-debug Turn on debugging],
11385 [case "$@{enableval@}" in
11388 *) AC_MSG_ERROR([bad value $@{enableval@} for --enable-debug]) ;;
11389 esac],[debug=false])
11390 AM_CONDITIONAL([DEBUG], [test x$debug = xtrue])
11393 Here is an example of how to use that conditional in @file{Makefile.am}:
11405 noinst_PROGRAMS = $(DBG)
11408 This trivial example could also be handled using @code{EXTRA_PROGRAMS}
11409 (@pxref{Conditional Programs}).
11411 You may only test a single variable in an @code{if} statement, possibly
11412 negated using @samp{!}. The @code{else} statement may be omitted.
11413 Conditionals may be nested to any depth. You may specify an argument to
11414 @code{else} in which case it must be the negation of the condition used
11415 for the current @code{if}. Similarly you may specify the condition
11416 that is closed on the @code{endif} line:
11427 Unbalanced conditions are errors. The @code{if}, @code{else}, and
11428 @code{endif} statements should not be indented, i.e., start on column
11431 The @code{else} branch of the above two examples could be omitted,
11432 since assigning the empty string to an otherwise undefined variable
11433 makes no difference.
11435 @acindex AM_COND_IF
11436 In order to allow access to the condition registered by
11437 @code{AM_CONDITIONAL} inside @file{configure.ac}, and to allow
11438 conditional @code{AC_CONFIG_FILES}, @code{AM_COND_IF} may be used:
11440 @defmac AM_COND_IF (@var{conditional}, @ovar{if-true}, @ovar{if-false})
11441 If @var{conditional} is fulfilled, execute @var{if-true}, otherwise
11442 execute @var{if-false}. If either branch contains @code{AC_CONFIG_FILES},
11443 it will cause @command{automake} to output the rules for the respective
11444 files only for the given condition.
11447 @code{AM_COND_IF} macros may be nested when m4 quotation is used
11448 properly (@pxref{M4 Quotation, ,, autoconf, The Autoconf Manual}).
11450 @cindex Example conditional @code{AC_CONFIG_FILES}
11451 @cindex @code{AC_CONFIG_FILES}, conditional
11453 Here is an example of how to define a conditional config file:
11456 AM_CONDITIONAL([SHELL_WRAPPER], [test "x$with_wrapper" = xtrue])
11457 AM_COND_IF([SHELL_WRAPPER],
11458 [AC_CONFIG_FILES([wrapper:wrapper.in])])
11461 @node Limits of Conditionals
11462 @section Limits of Conditionals
11464 Conditionals should enclose complete statements like variables or
11465 rules definitions. Automake cannot deal with conditionals used inside
11466 a variable definition, for instance, and is not even able to diagnose
11467 this situation. The following example would not work:
11470 # This syntax is not understood by Automake
11479 However the intended definition of @code{AM_CPPFLAGS} can be achieved
11484 DEBUGFLAGS = -DDEBUG
11486 AM_CPPFLAGS = -DFEATURE_A $(DEBUGFLAGS) -DFEATURE_B
11493 AM_CPPFLAGS = -DFEATURE_A
11495 AM_CPPFLAGS += -DDEBUG
11497 AM_CPPFLAGS += -DFEATURE_B
11500 More details and examples of conditionals are described alongside
11501 various Automake features in this manual (@pxref{Conditional
11502 Subdirectories}, @pxref{Conditional Sources}, @pxref{Conditional
11503 Programs}, @pxref{Conditional Libtool Libraries}, @pxref{Conditional
11506 @node Silencing Make
11507 @chapter Silencing @command{make}
11509 @cindex Silent @command{make}
11510 @cindex Silencing @command{make}
11511 @cindex Silent rules
11512 @cindex Silent @command{make} rules
11515 * Make verbosity:: Make is verbose by default
11516 * Tricks For Silencing Make:: Standard and generic ways to silence make
11517 * Automake Silent Rules:: How Automake can help in silencing make
11518 * Unsilencing Automake:: Showing commands.
11521 @node Make verbosity
11522 @section Make is verbose by default
11524 Normally, when executing the set of rules associated with a target,
11525 @command{make} prints each rule before it is executed. This behavior,
11526 despite having been in place since the beginning of @command{make},
11527 and being mandated by the POSIX standard, starkly violates the
11528 ``silence is golden'' UNIX principle@footnote{See also
11529 @uref{http://catb.org/~esr/writings/taoup/html/ch11s09.html}.}:
11532 When a program has nothing interesting or surprising to say, it should
11533 say nothing. Well-behaved Unix programs do their jobs unobtrusively,
11534 with a minimum of fuss and bother. Silence is golden.
11537 The traditional verbosity of @command{make} is understandable, as it
11538 is useful, often necessary, in order to understand reasons of
11539 failures. However, it can also hide warning and error messages from
11540 @command{make}-invoked tools, drowning them in uninteresting and
11541 seldom useful messages, and thus allowing them to easily go
11544 This can be quite problematic, especially for developers, who usually
11545 know quite well what's going on behind the scenes, and for whom the
11546 verbose output from @command{make} ends up being mostly noise that
11547 hampers the easy detection of potentially important warning messages.
11549 So Automake provides some support for silencing @command{make}.
11551 @node Tricks For Silencing Make
11552 @section Standard and generic ways to silence Make
11554 Here we describe some common idioms/tricks to obtain a quieter
11555 @command{make} output, with their relative advantages and drawbacks.
11556 In the next section (@ref{Automake Silent Rules}) we'll see how
11557 Automake can help in this respect, providing more elaborate and
11562 @item @command{make -s}
11564 This simply causes @command{make} not to print @emph{any} rule before
11567 The @option{-s} flag is mandated by POSIX, universally supported, and
11568 its purpose and function are easy to understand.
11570 But it also has serious limitations. First of all, it embodies an
11571 ``all or nothing'' strategy, i.e., either everything is silenced, or
11572 nothing is; in practice, this lack of granularity makes it unsuitable
11573 as a general solution. When the @option{-s} flag is used, the
11574 @command{make} output might turn out to be too terse; in case of
11575 errors, the user won't be able to easily see what rule or command have
11576 caused them, or even, in case of tools with poor error reporting, what
11579 @item @command{make >/dev/null || make}
11581 Apparently, this perfectly obeys the ``silence is golden'' rule: warnings
11582 from stderr are passed through, output reporting is done only in case of
11583 error, and in that case it should provide a verbose-enough report to allow
11584 an easy determination of the error location and causes.
11586 However, calling @command{make} two times in a row might hide errors
11587 (especially intermittent ones), or subtly change the expected
11588 semantics of the @command{make} calls---these things can clearly make
11589 debugging and error assessment very difficult.
11591 @item @command{make --no-print-directory}
11593 This is GNU @command{make} specific. When called with the
11594 @option{--no-print-directory} option, GNU @command{make} will disable
11595 printing of the working directory by invoked sub-@command{make}s (the
11596 well-known ``@i{Entering/Leaving directory @dots{}}'' messages). This
11597 helps to decrease the verbosity of the output, but experience has
11598 shown that it can also often render debugging considerably harder in
11599 projects using deeply-nested @command{make} recursion.
11601 As an aside, the @option{--no-print-directory} option is automatically
11602 activated if the @option{-s} flag is used.
11604 @c TODO: Other tricks?
11605 @c TODO: Maybe speak about the @code{.SILENT} target?
11606 @c TODO: - Pros: More granularity on what to silence.
11607 @c TODO: - Cons: No easy way to temporarily override.
11611 @node Automake Silent Rules
11612 @section How Automake can help in silencing Make
11614 The tricks and idioms for silencing @command{make} described in the
11615 previous section can be useful from time to time, but we've seen that
11616 they all have their serious drawbacks and limitations. That's why
11617 automake provides support for a more advanced and flexible way of
11618 obtaining quieter output from @command{make} (for most rules at least).
11620 To give the gist of what Automake can do in this respect, here is a simple
11621 comparison between a typical @command{make} output (where silent rules
11622 are disabled) and one with silent rules enabled:
11625 % @kbd{cat Makefile.am}
11627 foo_SOURCES = main.c func.c
11629 int main (void) @{ return func (); @} /* func used undeclared */
11631 int func (void) @{ int i; return i; @} /* i used uninitialized */
11633 @i{The make output is by default very verbose. This causes warnings
11634 from the compiler to be somewhat hidden, and not immediate to spot.}
11635 % @kbd{make CFLAGS=-Wall}
11636 gcc -DPACKAGE_NAME=\"foo\" -DPACKAGE_TARNAME=\"foo\" ...
11637 -DPACKAGE_STRING=\"foo\ 1.0\" -DPACKAGE_BUGREPORT=\"\" ...
11638 -DPACKAGE=\"foo\" -DVERSION=\"1.0\" -I. -Wall -MT main.o
11639 -MD -MP -MF .deps/main.Tpo -c -o main.o main.c
11640 main.c: In function ‘main’:
11641 main.c:3:3: warning: implicit declaration of function ‘func’
11642 mv -f .deps/main.Tpo .deps/main.Po
11643 gcc -DPACKAGE_NAME=\"foo\" -DPACKAGE_TARNAME=\"foo\" ...
11644 -DPACKAGE_STRING=\"foo\ 1.0\" -DPACKAGE_BUGREPORT=\"\" ...
11645 -DPACKAGE=\"foo\" -DVERSION=\"1.0\" -I. -Wall -MT func.o
11646 -MD -MP -MF .deps/func.Tpo -c -o func.o func.c
11647 func.c: In function ‘func’:
11648 func.c:4:3: warning: ‘i’ used uninitialized in this function
11649 mv -f .deps/func.Tpo .deps/func.Po
11650 gcc -Wall -o foo main.o func.o
11652 @i{Clean up, so that we can rebuild everything from scratch.}
11654 test -z "foo" || rm -f foo
11657 @i{Silent rules enabled: the output is minimal but informative.
11658 The warnings from the compiler stick out very clearly.}
11659 % @kbd{make V=0 CFLAGS=-Wall}
11661 main.c: In function ‘main’:
11662 main.c:3:3: warning: implicit declaration of function ‘func’
11664 func.c: In function ‘func’:
11665 func.c:4:3: warning: ‘i’ used uninitialized in this function
11669 @cindex silent rules and libtool
11670 Also, in projects using @command{libtool}, the use of silent rules can
11671 automatically enable the @command{libtool}'s @option{--silent} option:
11674 % @kbd{cat Makefile.am}
11675 lib_LTLIBRARIES = libx.la
11677 % @kbd{make # Both make and libtool are verbose by default.}
11679 libtool: compile: gcc -DPACKAGE_NAME=\"foo\" ... -DLT_OBJDIR=\".libs/\"
11680 -I. -g -O2 -MT libx.lo -MD -MP -MF .deps/libx.Tpo -c libx.c -fPIC
11681 -DPIC -o .libs/libx.o
11682 mv -f .deps/libx.Tpo .deps/libx.Plo
11683 /bin/sh ./libtool --tag=CC --mode=link gcc -g -O2 -o libx.la -rpath
11684 /usr/local/lib libx.lo
11685 libtool: link: gcc -shared .libs/libx.o -Wl,-soname -Wl,libx.so.0
11686 -o .libs/libx.so.0.0.0
11687 libtool: link: cd .libs && rm -f libx.so && ln -s libx.so.0.0.0 libx.so
11695 For Automake-generated @file{Makefile}s, the user may influence the
11696 verbosity at @command{configure} run time as well as at @command{make}
11701 @opindex --enable-silent-rules
11702 @opindex --disable-silent-rules
11703 Passing @option{--enable-silent-rules} to @command{configure} will cause
11704 build rules to be less verbose; the option @option{--disable-silent-rules}
11705 will cause normal verbose output.
11709 At @command{make} run time, the default chosen at @command{configure}
11710 time may be overridden: @code{make V=1} will produce verbose output,
11711 @code{make V=0} less verbose output.
11713 Unfortunately, if @code{V} is assigned a value other than 0 or 1,
11714 errors will result. This is problematic when a third-party program or
11715 library is built in the same tree and also uses the make variable
11716 @code{V}, with different values. The best workaround is probably to
11717 set @code{AM_V_P=true} (or similar), either on the make command line
11718 or in the @code{V}-using project's @code{Makefile.am}. (For more
11719 discussion, see @url{https://bugs.gnu.org/20077}.)
11722 @cindex default verbosity for silent rules
11723 Silent rules are @emph{disabled} by default; the user must enable them
11724 explicitly at either @command{configure} run time or at @command{make}
11725 run time. We think that this is a good policy, since it provides the
11726 casual user with enough information to prepare a good bug report in
11727 case anything breaks.
11729 Notwithstanding those rationales, developers who want to enable silent
11730 rules by default in their own packages can do so by calling
11731 @code{AM_SILENT_RULES([yes])} in @file{configure.ac}.
11733 @c Keep in sync with silent-configsite.sh
11734 Analogously, users who prefer to have silent rules enabled by default
11735 for everything on their system can edit their @file{config.site} file
11736 to make the variable @code{enable_silent_rules} default to @samp{yes}.
11737 This still allows disabling silent rules at @command{configure} time
11738 and at @command{make} time.
11740 To work best, the current implementation of this feature normally uses
11741 nested variable expansion @samp{$(@var{var1}$(V))}, a @file{Makefile}
11742 feature that is not required by POSIX 2008 but is widely supported in
11743 practice. On the rare @command{make} implementations that do not
11744 support nested variable expansion, whether rules are silent is always
11745 determined at configure time, and cannot be overridden at make time.
11746 Future versions of POSIX are likely to require nested variable
11747 expansion, so this minor limitation should go away with time.
11749 @vindex @code{AM_V_GEN}
11750 @vindex @code{AM_V_at}
11751 @vindex @code{AM_DEFAULT_VERBOSITY}
11752 @vindex @code{AM_V}
11753 @vindex @code{AM_DEFAULT_V}
11754 To extend the silent mode to your own rules, you have a few choices:
11758 You can use the predefined variable @code{AM_V_GEN} as a prefix to
11759 commands that should output a status line in silent mode, and
11760 @code{AM_V_at} as a prefix to commands that should not output anything
11761 in silent mode. When output is to be verbose, both of these variables
11762 will expand to the empty string.
11765 You can silence a recipe unconditionally with @code{@@}, and then use
11766 the predefined variable @code{AM_V_P} to know whether make is being run
11767 in silent or verbose mode; adjust the verbose information your recipe
11768 displays accordingly. For example:
11770 @c smallexample because text is too wide for normal example.
11774 ... [commands defining shell variable '$headers'] ...; \
11775 if $(AM_V_P); then set -x; else echo " GEN [headers]"; fi; \
11776 rm -f $$headers && generate-header --flags $$headers
11779 @code{AM_V_P} is (must be) always set to a simple command, not needing
11780 shell quoting, typically either @code{:} or @code{true} or
11784 You can add your own variables, so strings of your own choice are shown.
11785 The following snippet shows how you would define your own equivalent of
11786 @code{AM_V_GEN}, say a string @samp{PKG-GEN}:
11788 @c smallexample because regular example would look weird
11789 @c next to the smallexample above.
11791 pkg_verbose = $(pkg_verbose_@@AM_V@@)
11792 pkg_verbose_ = $(pkg_verbose_@@AM_DEFAULT_V@@)
11793 pkg_verbose_0 = @@echo PKG-GEN $@@;
11796 $(pkg_verbose)cp $(srcdir)/foo.in $@@
11801 Even when silent rules are enabled, the @option{--no-print-directory}
11802 option is still required with GNU @command{make} if the
11803 ``@i{Entering/Leaving directory @dots{}}'' messages are to be elided.
11805 @node Unsilencing Automake
11806 @section Unsilencing Automake
11808 @cindex unsilencing Automake
11809 @cindex verbose output from Automake
11811 With the @code{AM_SILENT_RULES} macro described in the previous
11812 section, Automake does a good job reducing @command{make} output to a
11813 bare minimum. Sometimes you want to see more than that. Let's
11814 summarize ways to get more information out of Automake packages:
11818 Running @code{make V=1} will produce generally verbose output.
11821 Adding @code{AM_V_GEN= AM_V_at=} will unsilence more rules. Thus, in all:
11822 @code{make V=1 AM_V_GEN= AM_V_at=}.
11824 @c VERBOSE=1 is (highly) relevant to the Automake test suite,
11825 @c but not in general, so shouldn't be mentioned here. See automake/HACKING.
11827 @c Adding @code{VERBOSE=1} can unsilence yet more. Thus, in all:
11828 @c ode{make V=1 AM_V_GEN= AM_V_at= VERBOSE=1}.
11831 Even this will not unsilence everything. To see the real truth of what
11832 gets executed, resort to GNU Make's debugging feature: @code{make
11833 --debug=p ... other args ...}. This reports every command being run,
11834 ignoring the @code{@@} prefix on rules (which silences them). In the
11835 case of Automake, these commands are generally complex shell
11836 constructs, and you'll want to track down the source files in Automake
11837 to actually understand them; but at least you'll have the text to
11838 search for. You may wish to include other debugging
11839 options. @xref{Options Summary,,,make, The GNU Make Manual}.
11844 @chapter When Automake Isn't Enough
11846 In some situations, where Automake is not up to one task, one has to
11847 resort to handwritten rules or even handwritten @file{Makefile}s.
11850 * Extending:: Adding new rules or overriding existing ones.
11851 * Third-Party Makefiles:: Integrating Non-Automake @file{Makefile}s.
11855 @section Extending Automake Rules
11857 With some minor exceptions (for example @code{_PROGRAMS} variables,
11858 @code{TESTS}, or @code{XFAIL_TESTS}) being rewritten to append
11859 @samp{$(EXEEXT)}), the contents of a @file{Makefile.am} is copied to
11860 @file{Makefile.in} verbatim.
11862 @cindex copying semantics
11864 These copying semantics mean that many problems can be worked around
11865 by simply adding some @command{make} variables and rules to
11866 @file{Makefile.am}. Automake will ignore these additions.
11868 @cindex conflicting definitions
11869 @cindex rules, conflicting
11870 @cindex variables, conflicting
11871 @cindex definitions, conflicts
11873 Since a @file{Makefile.in} is built from data gathered from three
11874 different places (@file{Makefile.am}, @file{configure.ac}, and
11875 @command{automake} itself), it is possible to have conflicting
11876 definitions of rules or variables. When building @file{Makefile.in}
11877 the following priorities are respected by @command{automake} to ensure
11878 the user always has the last word:
11882 User defined variables in @file{Makefile.am} have priority over
11883 variables @code{AC_SUBST}ed from @file{configure.ac}, and
11884 @code{AC_SUBST}ed variables have priority over
11885 @command{automake}-defined variables.
11887 As far as rules are concerned, a user-defined rule overrides any
11888 @command{automake}-defined rule for the same target.
11891 @cindex overriding rules
11892 @cindex overriding semantics
11893 @cindex rules, overriding
11895 These overriding semantics make it possible to fine tune some default
11896 settings of Automake, or replace some of its rules. Overriding
11897 Automake rules is often inadvisable, particularly in the topmost
11898 directory of a package with subdirectories. The @option{-Woverride}
11899 option (@pxref{automake Invocation}) comes in handy to catch overridden
11902 Note that Automake does not make any distinction between rules with
11903 commands and rules that only specify dependencies. So it is not
11904 possible to append new dependencies to an @command{automake}-defined
11905 target without redefining the entire rule.
11907 @cindex @option{-local} targets
11908 @cindex local targets
11910 However, various useful targets have a @samp{-local} version you can
11911 specify in your @file{Makefile.am}. Automake will supplement the
11912 standard target with these user-supplied targets.
11917 @trindex info-local
11925 @trindex html-local
11927 @trindex check-local
11929 @trindex install-data
11930 @trindex install-data-local
11931 @trindex install-dvi
11932 @trindex install-dvi-local
11933 @trindex install-exec
11934 @trindex install-exec-local
11935 @trindex install-html
11936 @trindex install-html-local
11937 @trindex install-info
11938 @trindex install-info-local
11939 @trindex install-pdf
11940 @trindex install-pdf-local
11941 @trindex install-ps
11942 @trindex install-ps-local
11944 @trindex uninstall-local
11945 @trindex mostlyclean
11946 @trindex mostlyclean-local
11948 @trindex clean-local
11950 @trindex distclean-local
11951 @trindex installdirs
11952 @trindex installdirs-local
11953 @trindex installcheck
11954 @trindex installcheck-local
11956 The targets that support a local version are @code{all}, @code{info},
11957 @code{dvi}, @code{ps}, @code{pdf}, @code{html}, @code{check},
11958 @code{install-data}, @code{install-dvi}, @code{install-exec},
11959 @code{install-html}, @code{install-info}, @code{install-pdf},
11960 @code{install-ps}, @code{uninstall}, @code{installdirs},
11961 @code{installcheck} and the various @code{clean} targets
11962 (@code{mostlyclean}, @code{clean}, @code{distclean}, and
11963 @code{maintainer-clean}).
11965 Note that there are no @code{uninstall-exec-local} or
11966 @code{uninstall-data-local} targets; just use @code{uninstall-local}.
11967 It doesn't make sense to uninstall just data or just executables.
11969 For instance, here is one way to erase a subdirectory during
11970 @samp{make clean} (@pxref{Clean}).
11977 You may be tempted to use @code{install-data-local} to install a file
11978 to some hard-coded location, but you should avoid this
11979 (@pxref{Hard-Coded Install Paths}).
11981 With the @code{-local} targets, there is no particular guarantee of
11982 execution order; typically, they are run early, but with parallel
11983 make, there is no way to be sure of that.
11985 @cindex @option{-hook} targets
11986 @cindex hook targets
11987 @trindex install-data-hook
11988 @trindex install-exec-hook
11989 @trindex uninstall-hook
11992 In contrast, some rules also have a way to run another rule, called a
11993 @dfn{hook}; hooks are always executed after the main rule's work is done.
11994 The hook is named after the principal target, with @samp{-hook} appended.
11995 The targets allowing hooks are @code{install-data},
11996 @code{install-exec}, @code{uninstall}, @code{dist}, and
11999 For instance, here is how to create a hard link to an installed program:
12003 ln $(DESTDIR)$(bindir)/program$(EXEEXT) \
12004 $(DESTDIR)$(bindir)/proglink$(EXEEXT)
12007 Although cheaper and more portable than symbolic links, hard links
12008 will not work everywhere (for instance, OS/2 does not have
12009 @command{ln}). Ideally you should fall back to @samp{cp -p} when
12010 @command{ln} does not work. An easy way, if symbolic links are
12011 acceptable to you, is to add @code{AC_PROG_LN_S} to
12012 @file{configure.ac} (@pxref{Particular Programs, , Particular Program
12013 Checks, autoconf, The Autoconf Manual}) and use @samp{$(LN_S)} in
12014 @file{Makefile.am}.
12016 @cindex versioned binaries, installing
12017 @cindex installing versioned binaries
12018 @cindex @code{LN_S} example
12019 For instance, here is how you could install a versioned copy of a
12020 program using @samp{$(LN_S)}:
12022 @c Keep in sync with insthook.sh
12025 cd $(DESTDIR)$(bindir) && \
12026 mv -f prog$(EXEEXT) prog-$(VERSION)$(EXEEXT) && \
12027 $(LN_S) prog-$(VERSION)$(EXEEXT) prog$(EXEEXT)
12030 Note that we rename the program so that a new version will erase the
12031 symbolic link, not the real binary. Also we @command{cd} into the
12032 destination directory in order to create relative links.
12034 When writing @code{install-exec-hook} or @code{install-data-hook},
12035 please bear in mind that the exec/data distinction is based on the
12036 installation directory, not on the primary used (@pxref{The Two Parts of
12038 @c Keep in sync with primary-prefix-couples-documented-valid.sh
12039 So a @code{foo_SCRIPTS} will be installed by
12040 @code{install-data}, and a @code{barexec_SCRIPTS} will be installed by
12041 @code{install-exec}. You should define your hooks accordingly.
12043 @c FIXME should include discussion of variables you can use in these
12046 @node Third-Party Makefiles
12047 @section Third-Party @file{Makefile}s
12049 @cindex Third-party packages, interfacing with
12050 @cindex Interfacing with third-party packages
12052 In most projects all @file{Makefile}s are generated by Automake. In
12053 some cases, however, projects need to embed subdirectories with
12054 handwritten @file{Makefile}s. For instance, one subdirectory could be
12055 a third-party project with its own build system, not using Automake.
12057 It is possible to list arbitrary directories in @code{SUBDIRS} or
12058 @code{DIST_SUBDIRS} provided each of these directories has a
12059 @file{Makefile} that recognizes all the following recursive targets.
12061 @cindex recursive targets and third-party @file{Makefile}s
12062 When a user runs one of these targets, that target is run recursively
12063 in all subdirectories. This is why it is important that even
12064 third-party @file{Makefile}s support them.
12068 Compile the entire package. This is the default target in
12069 Automake-generated @file{Makefile}s, but it does not need to be the
12070 default in third-party @file{Makefile}s.
12075 @vindex top_distdir
12076 Copy files to distribute into @samp{$(distdir)}, before a tarball is
12077 constructed. Of course this target is not required if the
12078 @option{no-dist} option (@pxref{Options}) is used.
12080 The variables @samp{$(top_distdir)} and @samp{$(distdir)}
12081 (@pxref{The dist Hook}) will be passed from the outer package to the subpackage
12082 when the @code{distdir} target is invoked. These two variables have
12083 been adjusted for the directory that is being recursed into, so they
12087 @itemx install-data
12088 @itemx install-exec
12090 Install or uninstall files (@pxref{Install}).
12093 @itemx install-html
12094 @itemx install-info
12097 Install only some specific documentation format (@pxref{Texinfo}).
12100 Create install directories, but do not install any files.
12103 @itemx installcheck
12104 Check the package (@pxref{Tests}).
12109 @itemx maintainer-clean
12110 Cleaning rules (@pxref{Clean}).
12117 Build the documentation in various formats (@pxref{Texinfo}).
12121 Build @file{TAGS} and @file{CTAGS} (@pxref{Tags}).
12124 If you have ever used Gettext in a project, this is a good example of
12125 how third-party @file{Makefile}s can be used with Automake. The
12126 @file{Makefile}s that @command{gettextize} puts in the @file{po/} and
12127 @file{intl/} directories are handwritten @file{Makefile}s that
12128 implement all of these targets. That way they can be added to
12129 @code{SUBDIRS} in Automake packages.
12131 Directories that are only listed in @code{DIST_SUBDIRS} but not in
12132 @code{SUBDIRS} need only the @code{distclean},
12133 @code{maintainer-clean}, and @code{distdir} rules (@pxref{Conditional
12136 Usually, many of these rules are irrelevant to the third-party
12137 subproject, but they are required for the whole package to work. It's
12138 OK to have a rule that does nothing, so if you are integrating a
12139 third-party project with no documentation or tag support, you could
12140 augment its @file{Makefile} as follows:
12142 @vindex EMPTY_AUTOMAKE_TARGETS
12143 @cindex Automake targets, no-op
12144 @cindex do-nothing Automake targets
12145 @cindex empty Automake targets
12146 @cindex no-op Automake targets
12147 @cindex targets, making into no-op
12149 EMPTY_AUTOMAKE_TARGETS = dvi pdf ps info html tags ctags
12150 .PHONY: $(EMPTY_AUTOMAKE_TARGETS)
12151 $(EMPTY_AUTOMAKE_TARGETS):
12154 To be clear, there is nothing special about the variable name
12155 @code{EMPTY_AUTOMAKE_TARGETS}; the name could be anything.
12157 Another aspect of integrating third-party build systems is whether
12158 they support VPATH builds (@pxref{VPATH Builds}). Obviously if the
12159 subpackage does not support VPATH builds the whole package will not
12160 support VPATH builds. This in turns means that @samp{make distcheck}
12161 will not work, because it relies on VPATH builds. Some people can
12162 live without this (indeed, many Automake users have never heard of
12163 @samp{make distcheck}). Other people may prefer to revamp the
12164 existing @file{Makefile}s to support VPATH@. Doing so does not
12165 necessarily require Automake; only Autoconf is needed (@pxref{Build
12166 Directories, , Build Directories, autoconf, The Autoconf Manual}).
12167 The necessary substitutions: @samp{@@srcdir@@}, @samp{@@top_srcdir@@},
12168 and @samp{@@top_builddir@@} are defined by @file{configure} when it
12169 processes a @file{Makefile} (@pxref{Preset Output Variables, , Preset
12170 Output Variables, autoconf, The Autoconf Manual}); they are not
12171 computed by the @file{Makefile} like the aforementioned @samp{$(distdir)} and
12172 @samp{$(top_distdir)} variables.
12174 It is sometimes inconvenient to modify a third-party @file{Makefile}
12175 to introduce the above required targets. For instance, one may want to
12176 keep the third-party sources untouched to ease upgrades to new
12179 @cindex @file{GNUmakefile} including @file{Makefile}
12180 Here are two other ideas. If GNU Make is assumed, one possibility is
12181 to add to that subdirectory a @file{GNUmakefile} that defines the
12182 required targets and includes the third-party @file{Makefile}. For
12183 this to work in VPATH builds, @file{GNUmakefile} must lie in the build
12184 directory; the easiest way to do this is to write a
12185 @file{GNUmakefile.in} instead, and have it processed with
12186 @code{AC_CONFIG_FILES} from the outer package. For example, if we
12187 assume @file{Makefile} defines all targets except the documentation
12188 targets, and that the real @code{check} target is named @code{test},
12189 we could write @file{GNUmakefile} (or @file{GNUmakefile.in}) like
12193 # First, include the real Makefile
12195 # Then, define the other targets needed by Automake Makefiles.
12196 .PHONY: dvi pdf ps info html check
12197 dvi pdf ps info html:
12201 @cindex Proxy @file{Makefile} for third-party packages
12202 A similar idea that does not use @code{include} is to write a proxy
12203 @file{Makefile} that dispatches rules to the real @file{Makefile},
12204 either with @samp{$(MAKE) -f Makefile.real $(AM_MAKEFLAGS) target} (if
12205 it's OK to rename the original @file{Makefile}) or with @samp{cd
12206 subdir && $(MAKE) $(AM_MAKEFLAGS) target} (if it's OK to store the
12207 subdirectory project one directory deeper). The good news is that
12208 this proxy @file{Makefile} can be generated with Automake. All we
12209 need are @option{-local} targets (@pxref{Extending}) that perform the
12210 dispatch. Of course the other Automake features are available, so you
12211 could decide to let Automake perform distribution or installation.
12212 Here is a possible @file{Makefile.am}:
12216 cd subdir && $(MAKE) $(AM_MAKEFLAGS) all
12218 cd subdir && $(MAKE) $(AM_MAKEFLAGS) test
12220 cd subdir && $(MAKE) $(AM_MAKEFLAGS) clean
12222 # Assuming the package knows how to install itself
12223 install-data-local:
12224 cd subdir && $(MAKE) $(AM_MAKEFLAGS) install-data
12225 install-exec-local:
12226 cd subdir && $(MAKE) $(AM_MAKEFLAGS) install-exec
12228 cd subdir && $(MAKE) $(AM_MAKEFLAGS) uninstall
12230 # Distribute files from here.
12231 EXTRA_DIST = subdir/Makefile subdir/program.c ...
12234 Pushing this idea to the extreme, it is also possible to ignore the
12235 subproject build system and build everything from this proxy
12236 @file{Makefile.am}. This might well be sensible if you need VPATH
12237 builds but the subproject does not support them.
12240 @chapter Distributing @file{Makefile.in}s
12242 Automake places no restrictions on the distribution of the resulting
12243 @file{Makefile.in}s. We encourage software authors to distribute
12244 their work under terms like those of the GPL, but doing so is not
12245 required to use Automake.
12247 Some of the files that can be automatically installed via the
12248 @option{--add-missing} switch do fall under the GPL@. However, these also
12249 have a special exception allowing you to distribute them with your
12250 package, regardless of the licensing you choose.
12253 @node API Versioning
12254 @chapter Automake API Versioning
12256 New Automake releases usually include bug fixes and new features.
12257 Unfortunately they may also introduce new bugs and incompatibilities.
12258 This makes four reasons why a package may require a particular Automake
12261 Things get worse when maintaining a large tree of packages, each one
12262 requiring a different version of Automake. In the past, this meant that
12263 any developer (and sometimes users) had to install several versions of
12264 Automake in different places, and switch @samp{$PATH} appropriately for
12267 Starting with version 1.6, Automake installs versioned binaries. This
12268 means you can install several versions of Automake in the same
12269 @samp{$prefix}, and can select an arbitrary Automake version by running
12270 @command{automake-1.6} or @command{automake-1.7} without juggling with
12271 @samp{$PATH}. Furthermore, @file{Makefile}s generated by Automake 1.6
12272 will use @command{automake-1.6} explicitly in their rebuild rules.
12274 The number @samp{1.6} in @command{automake-1.6} is Automake's API version,
12275 not Automake's version. If a bug fix release is made, for instance
12276 Automake 1.6.1, the API version will remain 1.6. This means that a
12277 package that works with Automake 1.6 should also work with 1.6.1; after
12278 all, this is what people expect from bug fix releases.
12280 If your package relies on a feature or a bug fix introduced in
12281 a release, you can pass this version as an option to Automake to ensure
12282 older releases will not be used. For instance, use this in your
12283 @file{configure.ac}:
12286 AM_INIT_AUTOMAKE([1.6.1]) dnl Require Automake 1.6.1 or better.
12290 or, in a particular @file{Makefile.am}:
12293 AUTOMAKE_OPTIONS = 1.6.1 # Require Automake 1.6.1 or better.
12297 Automake will print an error message if its version is
12298 older than the requested version.
12301 @heading What is in the API
12303 Automake's programming interface is not easy to define. Basically it
12304 should include at least all @strong{documented} variables and targets
12305 that a @file{Makefile.am} author can use, any behavior associated with
12306 them (e.g., the places where @samp{-hook}'s are run), the command line
12307 interface of @command{automake} and @command{aclocal}, @dots{}
12309 @heading What is not in the API
12311 Every undocumented variable, target, or command line option is not part
12312 of the API@. You should avoid using them, as they could change from one
12313 version to the other (even in bug fix releases, if this helps to fix a
12316 If it turns out you need to use such an undocumented feature, contact
12317 @email{automake@@gnu.org} and try to get it documented and exercised by
12321 @chapter Upgrading a Package to a Newer Automake Version
12323 Automake maintains three kinds of files in a package.
12326 @item @file{aclocal.m4}
12327 @item @file{Makefile.in}s
12328 @item auxiliary tools like @file{install-sh} or @file{py-compile}
12331 @file{aclocal.m4} is generated by @command{aclocal} and contains some
12332 Automake-supplied M4 macros. Auxiliary tools are installed by
12333 @samp{automake --add-missing} when needed. @file{Makefile.in}s are
12334 built from @file{Makefile.am} by @command{automake}, and rely on the
12335 definitions of the M4 macros put in @file{aclocal.m4} as well as the
12336 behavior of the auxiliary tools installed.
12338 Because all of these files are closely related, it is important to
12339 regenerate all of them when upgrading to a newer Automake release.
12340 The usual way to do that is
12343 aclocal # with any option needed (such as -I m4)
12345 automake --add-missing --force-missing
12349 or more conveniently:
12355 The use of @option{--force-missing} ensures that auxiliary tools will be
12356 overridden by new versions (@pxref{automake Invocation}).
12358 It is important to regenerate all of these files each time Automake is
12359 upgraded, even between bug fix releases. For instance, it is not
12360 unusual for a bug fix to involve changes to both the rules generated
12361 in @file{Makefile.in} and the supporting M4 macros copied to
12364 Presently @command{automake} is able to diagnose situations where
12365 @file{aclocal.m4} has been generated with another version of
12366 @command{aclocal}. However it never checks whether auxiliary scripts
12367 are up-to-date. In other words, @command{automake} will tell you when
12368 @command{aclocal} needs to be rerun, but it will never diagnose a
12369 missing @option{--force-missing}.
12371 Before upgrading to a new major release, it is a good idea to read the
12372 file @file{NEWS}. This file lists all changes between releases: new
12373 features, obsolete constructs, known incompatibilities, and
12377 @chapter Frequently Asked Questions about Automake
12379 This chapter covers some questions that often come up on the mailing
12383 * CVS:: CVS and generated files
12384 * maintainer-mode:: missing and AM_MAINTAINER_MODE
12385 * Wildcards:: Why doesn't Automake support wildcards?
12386 * Limitations on File Names:: Limitations on source and installed file names
12387 * Flag Variables Ordering:: CFLAGS vs.@: AM_CFLAGS vs.@: mumble_CFLAGS
12388 * Renamed Objects:: Why are object files sometimes renamed?
12389 * Per-Object Flags:: How to simulate per-object flags?
12390 * Multiple Outputs:: Writing rules for tools with many output files
12391 * Hard-Coded Install Paths:: Installing to hard-coded locations
12392 * Debugging Make Rules:: Strategies when things don't work as expected
12393 * Reporting Bugs:: Feedback on bugs and feature requests
12397 @section CVS and generated files
12399 @subheading Background: distributed generated Files
12400 @cindex generated files, distributed
12401 @cindex rebuild rules
12403 Packages made with Autoconf and Automake ship with some generated
12404 files like @file{configure} or @file{Makefile.in}. These files were
12405 generated on the developer's machine and are distributed so that
12406 end-users do not have to install the maintainer tools required to
12407 rebuild them. Other generated files like Lex scanners, Yacc parsers,
12408 or Info documentation are usually distributed on similar grounds.
12410 Automake output generates rules in @file{Makefile}s to rebuild these files.
12411 For instance, @command{make} will run @command{autoconf} to rebuild
12412 @file{configure} whenever @file{configure.ac} is changed. This makes
12413 development safer by ensuring a @file{configure} is never out-of-date
12414 with respect to @file{configure.ac}.
12416 As generated files shipped in packages are up-to-date, and because
12417 @command{tar} preserves times-tamps, these rebuild rules are not
12418 triggered when a user unpacks and builds a package.
12420 @subheading Background: CVS and Timestamps
12421 @cindex timestamps and CVS
12422 @cindex CVS and timestamps
12424 Unless you use CVS keywords (in which case files must be updated at
12425 commit time), CVS preserves timestamp during @samp{cvs commit} and
12426 @samp{cvs import -d} operations.
12428 When you check out a file using @samp{cvs checkout} its timestamp is
12429 set to that of the revision that is being checked out.
12431 However, during @command{cvs update}, files will have the date of the
12432 update, not the original timestamp of this revision. This is meant to
12433 make sure that @command{make} notices that sources files have been updated.
12435 This timestamp shift is troublesome when both sources and generated
12436 files are kept under CVS@. Because CVS processes files in lexical
12437 order, @file{configure.ac} will appear newer than @file{configure}
12438 after a @command{cvs update} that updates both files, even if
12439 @file{configure} was newer than @file{configure.ac} when it was
12440 checked in. Calling @command{make} will then trigger a spurious rebuild
12441 of @file{configure}.
12443 @subheading Living with CVS in Autoconfiscated Projects
12444 @cindex CVS and generated files
12445 @cindex generated files and CVS
12447 There are basically two clans amongst maintainers: those who keep all
12448 distributed files under CVS, including generated files, and those who
12449 keep generated files @emph{out} of CVS.
12451 @subsubheading All Files in CVS
12455 The CVS repository contains all distributed files so you know exactly
12456 what is distributed, and you can check out any prior version entirely.
12459 Maintainers can see how generated files evolve (for instance, you can
12460 see what happens to your @file{Makefile.in}s when you upgrade Automake
12461 and make sure they look OK).
12464 Users do not need Autotools to build a check-out of the project; it
12465 works just like a released tarball.
12468 If users use @command{cvs update} to update their copy, instead of
12469 @command{cvs checkout} to fetch a fresh one, timestamps will be
12470 inaccurate. Some rebuild rules will be triggered and attempt to
12471 run developer tools such as @command{autoconf} or @command{automake}.
12473 Calls to such tools are all wrapped into a call to the @command{missing}
12474 script discussed later (@pxref{maintainer-mode}), so that the user will
12475 see more descriptive warnings about missing or out-of-date tools, and
12476 possible suggestions about how to obtain them, rather than just some
12477 ``command not found'' error, or (worse) some obscure message from some
12478 older version of the required tool they happen to have installed.
12480 Maintainers interested in keeping their package buildable from a CVS
12481 checkout even for those users that lack maintainer-specific tools might
12482 want to provide a helper script (or to enhance their existing bootstrap
12483 script) to fix the timestamps after a
12484 @command{cvs update} or a @command{git checkout}, to prevent spurious
12485 rebuilds. In case of a project committing the Autotools-generated
12486 files, as well as the generated @file{.info} files, such a script might
12487 look something like this:
12491 # fix-timestamp.sh: prevents useless rebuilds after "cvs update"
12493 # aclocal-generated aclocal.m4 depends on locally-installed
12494 # '.m4' macro files, as well as on 'configure.ac'
12497 # autoconf-generated configure depends on aclocal.m4 and on
12500 # so does autoheader-generated config.h.in
12502 # and all the automake-generated Makefile.in files
12503 touch `find . -name Makefile.in -print`
12504 # finally, the makeinfo-generated '.info' files depend on the
12505 # corresponding '.texi' files
12510 In distributed development, developers are likely to have different
12511 versions of the maintainer tools installed. In this case rebuilds
12512 triggered by timestamp lossage will lead to spurious changes
12513 to generated files. There are several solutions to this:
12517 All developers should use the same versions, so that the rebuilt files
12518 are identical to files in CVS@. (This starts to be difficult when each
12519 project you work on uses different versions.)
12521 Or people use a script to fix the timestamp after a checkout (the GCC
12522 folks have such a script).
12524 Or @file{configure.ac} uses @code{AM_MAINTAINER_MODE}, which will
12525 disable all of these rebuild rules by default. This is further discussed
12526 in @ref{maintainer-mode}.
12530 Although we focused on spurious rebuilds, the converse can also
12531 happen. CVS's timestamp handling can also let you think an
12532 out-of-date file is up-to-date.
12534 For instance, suppose a developer has modified @file{Makefile.am} and
12535 has rebuilt @file{Makefile.in}, and then decides to do a last-minute
12536 change to @file{Makefile.am} right before checking in both files
12537 (without rebuilding @file{Makefile.in} to account for the change).
12539 This last change to @file{Makefile.am} makes the copy of
12540 @file{Makefile.in} out-of-date. Since CVS processes files
12541 alphabetically, when another developer @samp{cvs update}s his or her
12542 tree, @file{Makefile.in} will happen to be newer than
12543 @file{Makefile.am}. This other developer will not see that
12544 @file{Makefile.in} is out-of-date.
12548 @subsubheading Generated Files out of CVS
12550 One way to get CVS and @command{make} working peacefully is to never
12551 store generated files in CVS, i.e., do not CVS-control files that
12552 are @file{Makefile} targets (also called @emph{derived} files).
12554 This way developers are not annoyed by changes to generated files. It
12555 does not matter if they all have different versions (assuming they are
12556 compatible, of course). And finally, timestamps are not lost; changes
12557 to sources files can't be missed as in the
12558 @file{Makefile.am}/@file{Makefile.in} example discussed earlier.
12560 The drawback is that the CVS repository is not an exact copy of what
12561 is distributed and that users now need to install various development
12562 tools (maybe even specific versions) before they can build a checkout.
12563 But, after all, CVS's job is versioning, not distribution.
12565 Allowing developers to use different versions of their tools can also
12566 hide bugs during distributed development. Indeed, developers will be
12567 using (hence testing) their own generated files, instead of the
12568 generated files that will be released. The developer who prepares the
12569 tarball might be using a version of the tool that produces bogus
12570 output (for instance a non-portable C file), something other
12571 developers could have noticed if they weren't using their own versions
12574 @subheading Third-party Files
12575 @cindex CVS and third-party files
12576 @cindex third-party files and CVS
12578 Another class of files not discussed here (because they do not cause
12579 timestamp issues) are files that are shipped with a package, but
12580 maintained elsewhere. For instance, tools like @command{gettextize}
12581 and @command{autopoint} (from Gettext) or @command{libtoolize} (from
12582 Libtool), will install or update files in your package.
12584 These files, whether they are kept under CVS or not, raise similar
12585 concerns about version mismatch between developers' tools. The
12586 Gettext manual has a section about this; see @ref{Version Control Issues,,
12587 Integrating with Version Control Systems, gettext, GNU gettext tools}.
12589 @node maintainer-mode
12590 @section @command{missing} and @code{AM_MAINTAINER_MODE}
12592 @subheading @command{missing}
12593 @cindex @command{missing}, purpose
12595 The @command{missing} script is a wrapper around several maintainer
12596 tools, designed to warn users if a maintainer tool is required but
12597 missing. Typical maintainer tools are @command{autoconf},
12598 @command{automake}, @command{bison}, etc. Because files generated by
12599 these tools are shipped with the other sources of a package, these
12600 tools shouldn't be required during a user build and they are not
12601 checked for in @file{configure}.
12603 However, if for some reason a rebuild rule is triggered and involves a
12604 missing tool, @command{missing} will notice it and warn the user, even
12605 suggesting how to obtain such a tool (at least in case it is a well-known
12606 one, like @command{makeinfo} or @command{bison}). This is more helpful
12607 and user-friendly than just having the rebuild rules spewing out a terse
12608 error message like @samp{sh: @var{tool}: command not found}. Similarly,
12609 @command{missing} will warn the user if it detects that a maintainer
12610 tool it attempted to use seems too old (be warned that diagnosing this
12611 correctly is typically more difficult than detecting missing tools, and
12612 requires cooperation from the tool itself, so it won't always work).
12614 If the required tool is installed, @command{missing} will run it and
12615 won't attempt to continue after failures. This is correct behavior during
12616 development: developers love fixing failures. However, users with
12617 missing or too old maintainer tools may get an error when the rebuild
12618 rule is spuriously triggered, halting the build. This failure to let
12619 the build continue is one of the arguments of the
12620 @code{AM_MAINTAINER_MODE} advocates.
12622 @subheading @code{AM_MAINTAINER_MODE}
12623 @cindex @code{AM_MAINTAINER_MODE}, purpose
12624 @acindex AM_MAINTAINER_MODE
12626 @code{AM_MAINTAINER_MODE} allows you to choose whether the so called
12627 "rebuild rules" should be enabled or disabled. With
12628 @code{AM_MAINTAINER_MODE([enable])}, they are enabled by default;
12629 otherwise they are disabled by default. In the latter case, if you
12630 have @code{AM_MAINTAINER_MODE} in @file{configure.ac}, and run
12631 @samp{./configure && make}, then @command{make} will *never* attempt
12632 to rebuild @file{configure}, @file{Makefile.in}s, Lex or Yacc outputs,
12633 etc. That is, this disables build rules for files that are usually
12634 distributed and that users should normally not have to update.
12636 The user can override the default setting by passing either
12637 @samp{--enable-maintainer-mode} or @samp{--disable-maintainer-mode}
12638 to @command{configure}.
12640 People use @code{AM_MAINTAINER_MODE} either because they do not want their
12641 users (or themselves) annoyed by timestamp lossage (@pxref{CVS}), or
12642 because they simply can't stand the rebuild rules and prefer running
12643 maintainer tools explicitly.
12645 @code{AM_MAINTAINER_MODE} also allows you to disable some custom build
12646 rules conditionally. Some developers use this feature to disable
12647 rules that need exotic tools that users may not have available.
12649 Several years ago Fran@,{c}ois Pinard pointed out several arguments
12650 against this @code{AM_MAINTAINER_MODE} macro. Most of them relate to
12651 insecurity. By removing dependencies you get non-dependable builds:
12652 changes to source files can have no effect on generated files and this
12653 can be very confusing when unnoticed. He adds that security shouldn't
12654 be reserved to maintainers (what @option{--enable-maintainer-mode}
12655 suggests), on the contrary. If one user has to modify a
12656 @file{Makefile.am}, then either @file{Makefile.in} should be updated
12657 or a warning should be output (this is what Automake uses
12658 @command{missing} for) but the last thing you want is that nothing
12659 happens and the user doesn't notice it (this is what happens when
12660 rebuild rules are disabled by @code{AM_MAINTAINER_MODE}).
12662 Jim Meyering, the inventor of the @code{AM_MAINTAINER_MODE} macro, was
12663 swayed by Fran@,{c}ois' arguments, and got rid of
12664 @code{AM_MAINTAINER_MODE} in all of his packages.
12666 Still many people continue to use @code{AM_MAINTAINER_MODE}, because
12667 it helps them working on projects where all files are kept under version
12668 control, and because @command{missing} isn't enough if you have the
12669 wrong version of the tools.
12673 @section Why doesn't Automake support wildcards?
12676 Developers are lazy. They would often like to use wildcards in
12677 @file{Makefile.am}s, so that they would not need to remember to
12678 update @file{Makefile.am}s every time they add, delete, or rename
12681 There are several objections to this:
12684 When using CVS (or similar) developers need to remember they have to
12685 run @samp{cvs add} or @samp{cvs rm} anyway. Updating
12686 @file{Makefile.am} accordingly quickly becomes a reflex.
12688 Conversely, if your application doesn't compile
12689 because you forgot to add a file in @file{Makefile.am}, it will help
12690 you remember to @samp{cvs add} it.
12693 Using wildcards makes it easy to distribute files by mistake. For
12694 instance, some code a developer is experimenting with (a test case,
12695 say) that should not be part of the distribution.
12698 Using wildcards it's easy to omit some files by mistake. For
12699 instance, one developer creates a new file, uses it in many places,
12700 but forgets to commit it. Another developer then checks out the
12701 incomplete project and is able to run @samp{make dist} successfully,
12702 even though a file is missing. By listing files, @samp{make dist}
12703 @emph{will} complain.
12706 Wildcards are not portable to some non-GNU @command{make} implementations,
12707 e.g., NetBSD @command{make} will not expand globs such as @samp{*} in
12708 prerequisites of a target.
12711 Finally, it's quite hard to @emph{forget} to add a file to
12712 @file{Makefile.am}: files that are not listed in @file{Makefile.am}
12713 are not compiled or installed, so you can't even test them.
12716 Still, these are philosophical objections, and as such you may disagree,
12717 or find enough value in wildcards to dismiss all of them. Before you
12718 start writing a patch against Automake to teach it about wildcards,
12719 let's see the main technical issue: portability.
12721 Although @samp{$(wildcard ...)} works with GNU @command{make}, it is
12722 not portable to other @command{make} implementations.
12724 The only way Automake could support @command{$(wildcard ...)} is by
12725 expanding @command{$(wildcard ...)} when @command{automake} is run.
12726 The resulting @file{Makefile.in}s would be portable since they would
12727 list all files and not use @samp{$(wildcard ...)}. However that
12728 means developers would need to remember to run @command{automake} each
12729 time they add, delete, or rename files.
12731 Compared to editing @file{Makefile.am}, this is a very small gain. Sure,
12732 it's easier and faster to type @samp{automake; make} than to type
12733 @samp{emacs Makefile.am; make}. But nobody bothered enough to write a
12734 patch to add support for this syntax. Some people use scripts to
12735 generate file lists in @file{Makefile.am} or in separate
12736 @file{Makefile} fragments.
12738 Even if you don't care about portability, and are tempted to use
12739 @samp{$(wildcard ...)} anyway because you target only GNU Make, you
12740 should know there are many places where Automake needs to know exactly
12741 which files should be processed. As Automake doesn't know how to
12742 expand @samp{$(wildcard ...)}, you cannot use it in these places.
12743 @samp{$(wildcard ...)} is a black box comparable to @code{AC_SUBST}ed
12744 variables as far Automake is concerned.
12746 You can get warnings about @samp{$(wildcard ...}) constructs using the
12747 @option{-Wportability} flag.
12749 @node Limitations on File Names
12750 @section Limitations on File Names
12751 @cindex file names, limitations on
12753 Automake attempts to support all kinds of file names, even those that
12754 contain unusual characters or are unusually long. However, some
12755 limitations are imposed by the underlying operating system and tools.
12757 Most operating systems prohibit the use of the null byte in file
12758 names, and reserve @samp{/} as a directory separator. Also, they
12759 require that file names are properly encoded for the user's locale.
12760 Automake is subject to these limits.
12762 Portable packages should limit themselves to POSIX file
12763 names. These can contain ASCII letters and digits,
12764 @samp{_}, @samp{.}, and @samp{-}. File names consist of components
12765 separated by @samp{/}. File name components cannot begin with
12768 Portable POSIX file names cannot contain components that exceed a
12769 14-byte limit, but nowadays it's normally safe to assume the
12770 more-generous XOPEN limit of 255 bytes. POSIX
12771 limits file names to 255 bytes (XOPEN allows 1023 bytes),
12772 but you may want to limit a source tarball to file names of 99 bytes
12773 to avoid interoperability problems with old versions of @command{tar}.
12775 If you depart from these rules (e.g., by using non-ASCII
12776 characters in file names, or by using lengthy file names), your
12777 installers may have problems for reasons unrelated to Automake.
12778 However, if this does not concern you, you should know about the
12779 limitations imposed by Automake itself. These limitations are
12780 undesirable, but some of them seem to be inherent to underlying tools
12781 like Autoconf, Make, M4, and the shell. They fall into three
12782 categories: install directories, build directories, and file names.
12784 The following characters:
12787 @r{newline} " # $ ' `
12790 should not appear in the names of install directories. For example,
12791 the operand of @command{configure}'s @option{--prefix} option should
12792 not contain these characters.
12794 Build directories suffer the same limitations as install directories,
12795 and in addition should not contain the following characters:
12801 For example, the full name of the directory containing the source
12802 files should not contain these characters.
12804 Source and installation file names like @file{main.c} are limited even
12805 further: they should conform to the POSIX/XOPEN
12806 rules described above. In addition, if you plan to port to
12807 non-POSIX environments, you should avoid file names that
12808 differ only in case (e.g., @file{makefile} and @file{Makefile}).
12809 Nowadays it is no longer worth worrying about the 8.3 limits of
12812 @node Flag Variables Ordering
12813 @section Flag Variables Ordering
12814 @cindex Ordering flag variables
12815 @cindex Flag variables, ordering
12818 What is the difference between @code{AM_CFLAGS}, @code{CFLAGS}, and
12819 @code{mumble_CFLAGS}?
12823 Why does @command{automake} output @code{CPPFLAGS} after
12824 @code{AM_CPPFLAGS} on compile lines? Shouldn't it be the converse?
12828 My @file{configure} adds some warning flags into @code{CXXFLAGS}. In
12829 one @file{Makefile.am} I would like to append a new flag, however if I
12830 put the flag into @code{AM_CXXFLAGS} it is prepended to the other
12831 flags, not appended.
12834 @subheading Compile Flag Variables
12835 @cindex Flag Variables, Ordering
12836 @cindex Compile Flag Variables
12837 @cindex @code{AM_CCASFLAGS} and @code{CCASFLAGS}
12838 @cindex @code{AM_CFLAGS} and @code{CFLAGS}
12839 @cindex @code{AM_CPPFLAGS} and @code{CPPFLAGS}
12840 @cindex @code{AM_CXXFLAGS} and @code{CXXFLAGS}
12841 @cindex @code{AM_FCFLAGS} and @code{FCFLAGS}
12842 @cindex @code{AM_FFLAGS} and @code{FFLAGS}
12843 @cindex @code{AM_GCJFLAGS} and @code{GCJFLAGS}
12844 @cindex @code{AM_LDFLAGS} and @code{LDFLAGS}
12845 @cindex @code{AM_LFLAGS} and @code{LFLAGS}
12846 @cindex @code{AM_LIBTOOLFLAGS} and @code{LIBTOOLFLAGS}
12847 @cindex @code{AM_OBJCFLAGS} and @code{OBJCFLAGS}
12848 @cindex @code{AM_OBJCXXFLAGS} and @code{OBJXXCFLAGS}
12849 @cindex @code{AM_RFLAGS} and @code{RFLAGS}
12850 @cindex @code{AM_UPCFLAGS} and @code{UPCFLAGS}
12851 @cindex @code{AM_YFLAGS} and @code{YFLAGS}
12852 @cindex @code{CCASFLAGS} and @code{AM_CCASFLAGS}
12853 @cindex @code{CFLAGS} and @code{AM_CFLAGS}
12854 @cindex @code{CPPFLAGS} and @code{AM_CPPFLAGS}
12855 @cindex @code{CXXFLAGS} and @code{AM_CXXFLAGS}
12856 @cindex @code{FCFLAGS} and @code{AM_FCFLAGS}
12857 @cindex @code{FFLAGS} and @code{AM_FFLAGS}
12858 @cindex @code{GCJFLAGS} and @code{AM_GCJFLAGS}
12859 @cindex @code{LDFLAGS} and @code{AM_LDFLAGS}
12860 @cindex @code{LFLAGS} and @code{AM_LFLAGS}
12861 @cindex @code{LIBTOOLFLAGS} and @code{AM_LIBTOOLFLAGS}
12862 @cindex @code{OBJCFLAGS} and @code{AM_OBJCFLAGS}
12863 @cindex @code{OBJCXXFLAGS} and @code{AM_OBJCXXFLAGS}
12864 @cindex @code{RFLAGS} and @code{AM_RFLAGS}
12865 @cindex @code{UPCFLAGS} and @code{AM_UPCFLAGS}
12866 @cindex @code{YFLAGS} and @code{AM_YFLAGS}
12868 This section attempts to answer all the above questions. We will
12869 mostly discuss @code{CPPFLAGS} in our examples, but the answer holds
12870 for all the compile flags used in Automake: @code{CCASFLAGS},
12871 @code{CFLAGS}, @code{CPPFLAGS}, @code{CXXFLAGS}, @code{FCFLAGS},
12872 @code{FFLAGS}, @code{GCJFLAGS}, @code{LDFLAGS}, @code{LFLAGS},
12873 @code{LIBTOOLFLAGS}, @code{OBJCFLAGS}, @code{OBJCXXFLAGS},
12874 @code{RFLAGS}, @code{UPCFLAGS}, and @code{YFLAGS}.
12876 @code{CPPFLAGS}, @code{AM_CPPFLAGS}, and @code{mumble_CPPFLAGS} are
12877 three variables that can be used to pass flags to the C preprocessor (
12878 these variables are also used for other languages like C++ or
12879 preprocessed Fortran). @code{CPPFLAGS} is the user variable
12880 (@pxref{User Variables}), @code{AM_CPPFLAGS} is the Automake variable,
12881 and @code{mumble_CPPFLAGS} is the variable specific to the
12882 @code{mumble} target (we call this a per-target variable,
12883 @pxref{Program and Library Variables}).
12885 Automake always uses two of these variables when compiling C sources
12886 files. When compiling an object file for the @code{mumble} target,
12887 the first variable will be @code{mumble_CPPFLAGS} if it is defined, or
12888 @code{AM_CPPFLAGS} otherwise. The second variable is always
12891 In the following example,
12894 bin_PROGRAMS = foo bar
12895 foo_SOURCES = xyz.c
12896 bar_SOURCES = main.c
12897 foo_CPPFLAGS = -DFOO
12898 AM_CPPFLAGS = -DBAZ
12902 @file{xyz.o} will be compiled with @samp{$(foo_CPPFLAGS) $(CPPFLAGS)},
12903 (because @file{xyz.o} is part of the @code{foo} target), while
12904 @file{main.o} will be compiled with @samp{$(AM_CPPFLAGS) $(CPPFLAGS)}
12905 (because there is no per-target variable for target @code{bar}).
12907 The difference between @code{mumble_CPPFLAGS} and @code{AM_CPPFLAGS}
12908 being clear enough, let's focus on @code{CPPFLAGS}. @code{CPPFLAGS}
12909 is a user variable, i.e., a variable that users are entitled to modify
12910 in order to compile the package. This variable, like many others,
12911 is documented at the end of the output of @samp{configure --help}.
12913 For instance, someone who needs to add @file{/home/my/usr/include} to
12914 the C compiler's search path would configure a package with
12917 ./configure CPPFLAGS='-I /home/my/usr/include'
12921 and this flag would be propagated to the compile rules of all
12924 It is also not uncommon to override a user variable at
12925 @command{make}-time. Many installers do this with @code{prefix}, but
12926 this can be useful with compiler flags too. For instance, while
12927 debugging a C++ project, if you need to disable optimization in one
12928 specific object file, you can run something like
12932 make CXXFLAGS=-O0 file.o
12936 The reason @samp{$(CPPFLAGS)} appears after @samp{$(AM_CPPFLAGS)} or
12937 @samp{$(mumble_CPPFLAGS)} in the compile command is that users should
12938 have the last say. In the example above, the desire is for the
12939 @samp{CXXFLAGS=-O0} to supersede any other switch from
12940 @code{AM_CXXFLAGS} or @code{mumble_CXXFLAGS}.
12942 @c https://bugs.gnu.org/35526
12943 It's true that not all options to all programs can be overridden. So
12944 in general, users could conceivably want to place options at arbitrary
12945 places in the command line, but Automake does not support this. It
12946 would be difficult to make such generality comprehensible. Being able
12947 to specify the final options commonly suffices.
12949 Thus, you should never redefine a user variable such as
12950 @code{CPPFLAGS} in @file{Makefile.am}. Use @samp{automake -Woverride}
12951 to diagnose such mistakes. Even something like
12954 CPPFLAGS = -DDATADIR=\"$(datadir)\" @@CPPFLAGS@@
12958 is erroneous. Although this preserves @file{configure}'s value of
12959 @code{CPPFLAGS}, the definition of @code{DATADIR} will disappear if a
12960 user attempts to override @code{CPPFLAGS} from the @command{make}
12964 AM_CPPFLAGS = -DDATADIR=\"$(datadir)\"
12968 is all that is needed here if no per-target flags are used.
12970 You should not add options to these user variables within
12971 @file{configure} either, for the same reason. Occasionally you need
12972 to modify these variables to perform a test, but you should reset
12973 their values afterwards. In contrast, it is OK to modify the
12974 @samp{AM_} variables within @file{configure} if you @code{AC_SUBST}
12975 them, but it is rather rare that you need to do this, unless you want
12976 to change the default definitions of the @samp{AM_} variables in all
12979 What we recommend is that you define extra flags in separate
12980 variables. For instance, you may write an Autoconf macro that computes
12981 a set of warning options for the C compiler, and @code{AC_SUBST} them
12982 in @code{WARNINGCFLAGS}; you may also have an Autoconf macro that
12983 determines which compiler and which linker flags should be used to
12984 link with library @file{libfoo}, and @code{AC_SUBST} these in
12985 @code{LIBFOOCFLAGS} and @code{LIBFOOLDFLAGS}. Then, a
12986 @file{Makefile.am} could use these variables as follows:
12989 AM_CFLAGS = $(WARNINGCFLAGS)
12990 bin_PROGRAMS = prog1 prog2
12991 prog1_SOURCES = @dots{}
12992 prog2_SOURCES = @dots{}
12993 prog2_CFLAGS = $(LIBFOOCFLAGS) $(AM_CFLAGS)
12994 prog2_LDFLAGS = $(LIBFOOLDFLAGS)
12997 In this example both programs will be compiled with the flags
12998 substituted into @samp{$(WARNINGCFLAGS)}, and @code{prog2} will
12999 additionally be compiled with the flags required to link with
13002 Note that listing @code{AM_CFLAGS} in a per-target @code{CFLAGS}
13003 variable is a common idiom to ensure that @code{AM_CFLAGS} applies to
13004 every target in a @file{Makefile.in}.
13006 Using variables like this gives you full control over the ordering of
13007 the flags. For instance, if there is a flag in $(WARNINGCFLAGS) that
13008 you want to negate for a particular target, you can use something like
13009 @samp{prog1_CFLAGS = $(AM_CFLAGS) -no-flag}. If all of these flags had
13010 been forcefully appended to @code{CFLAGS}, there would be no way to
13011 disable one flag. Yet another reason to leave user variables to
13014 Finally, we have avoided naming the variable of the example
13015 @code{LIBFOO_LDFLAGS} (with an underscore) because that would cause
13016 Automake to think that this is a per-target variable (like
13017 @code{mumble_LDFLAGS}) for some non-declared @code{LIBFOO} target.
13019 @subheading Other Variables
13021 There are other variables in Automake that follow similar principles
13022 to allow user options. For instance, Texinfo rules (@pxref{Texinfo})
13023 use @code{MAKEINFOFLAGS} and @code{AM_MAKEINFOFLAGS}. Similarly,
13024 DejaGnu tests (@pxref{DejaGnu Tests}) use @code{RUNTESTFLAGS} and
13025 @code{AM_RUNTESTFLAGS}. The tags and ctags rules
13026 (@pxref{Tags}) use @code{ETAGSFLAGS}, @code{AM_ETAGSFLAGS},
13027 @code{CTAGSFLAGS}, and @code{AM_CTAGSFLAGS}. Java rules
13028 (@pxref{Java}) use @code{JAVACFLAGS} and @code{AM_JAVACFLAGS}. None
13029 of these rules support per-target flags (yet).
13031 To some extent, even @code{AM_MAKEFLAGS} (@pxref{Subdirectories})
13032 obeys this naming scheme. The slight difference is that
13033 @code{MAKEFLAGS} is passed to sub-@command{make}s implicitly by
13034 @command{make} itself.
13036 @code{ARFLAGS} (@pxref{A Library}) is usually defined by Automake and
13037 has neither an @code{AM_} nor a per-target cousin.
13039 Finally you should not think that the existence of a per-target
13040 variable implies the existence of an @code{AM_} variable or of a user
13041 variable. For instance, the @code{mumble_LDADD} per-target variable
13042 overrides the makefile-wide @code{LDADD} variable (which is not a user
13043 variable), and @code{mumble_LIBADD} exists only as a per-target
13044 variable. @xref{Program and Library Variables}.
13047 @node Renamed Objects
13048 @section Why are object files sometimes renamed?
13050 This happens when per-target compilation flags are used. Object
13051 files need to be renamed just in case they would clash with object
13052 files compiled from the same sources, but with different flags.
13053 Consider the following example.
13056 bin_PROGRAMS = true false
13057 true_SOURCES = generic.c
13058 true_CPPFLAGS = -DEXIT_CODE=0
13059 false_SOURCES = generic.c
13060 false_CPPFLAGS = -DEXIT_CODE=1
13064 Obviously the two programs are built from the same source, but it
13065 would be bad if they shared the same object, because @file{generic.o}
13066 cannot be built with both @samp{-DEXIT_CODE=0} @emph{and}
13067 @samp{-DEXIT_CODE=1}. Therefore @command{automake} outputs rules to
13068 build two different objects: @file{true-generic.o} and
13069 @file{false-generic.o}.
13071 Automake doesn't actually determine whether source files are shared to
13072 decide if it must rename objects. It just renames all objects of a
13073 target as soon as it sees that per-target compilation flags are used.
13075 It's OK to share object files when per-target compilation flags are not
13076 used. For instance, @file{true} and @file{false} will both use
13077 @file{version.o} in the following example.
13080 AM_CPPFLAGS = -DVERSION=1.0
13081 bin_PROGRAMS = true false
13082 true_SOURCES = true.c version.c
13083 false_SOURCES = false.c version.c
13086 Note that the renaming of objects is also affected by the
13087 @code{_SHORTNAME} variable (@pxref{Program and Library Variables}).
13090 @node Per-Object Flags
13091 @section Per-Object Flags Emulation
13092 @cindex Per-object flags, emulated
13095 One of my source files needs to be compiled with different flags. How
13099 Automake supports per-program and per-library compilation flags (see
13100 @ref{Program and Library Variables} and @ref{Flag Variables
13101 Ordering}). With this you can define compilation flags that apply to
13102 all files compiled for a target. For instance, in
13106 foo_SOURCES = foo.c foo.h bar.c bar.h main.c
13107 foo_CFLAGS = -some -flags
13111 @file{foo-foo.o}, @file{foo-bar.o}, and @file{foo-main.o} will all be
13112 compiled with @samp{-some -flags}. (If you wonder about the names of
13113 these object files, see @ref{Renamed Objects}.) Note that
13114 @code{foo_CFLAGS} gives the flags to use when compiling all the C
13115 sources of the @emph{program} @code{foo}; it has nothing to do with
13116 @file{foo.c} or @file{foo-foo.o} specifically.
13118 What if @file{foo.c} needs to be compiled into @file{foo.o} using some
13119 specific flags, that none of the other files requires? Obviously
13120 per-program flags are not directly applicable here. Something like
13121 per-object flags are expected, i.e., flags that would be used only
13122 when creating @file{foo-foo.o}. Automake does not support that;
13123 however this is easy to simulate using a library that contains only
13124 that object, and compiling this library with per-library flags.
13128 foo_SOURCES = bar.c bar.h main.c
13129 foo_CFLAGS = -some -flags
13130 foo_LDADD = libfoo.a
13131 noinst_LIBRARIES = libfoo.a
13132 libfoo_a_SOURCES = foo.c foo.h
13133 libfoo_a_CFLAGS = -some -other -flags
13136 Here @file{foo-bar.o} and @file{foo-main.o} will all be
13137 compiled with @samp{-some -flags}, while @file{libfoo_a-foo.o} will
13138 be compiled using @samp{-some -other -flags}. Eventually, all
13139 three objects will be linked to form @file{foo}.
13141 This trick can also be achieved using Libtool convenience libraries,
13142 for instance @samp{noinst_LTLIBRARIES = libfoo.la} (@pxref{Libtool
13143 Convenience Libraries}).
13145 Another tempting idea to implement per-object flags is to override the
13146 compile rules @command{automake} would output for these files.
13147 Automake will not define a rule for a target you have defined, so you
13148 could think about defining the @samp{foo-foo.o: foo.c} rule yourself.
13149 We recommend against this, because this is error prone. For instance,
13150 if you add such a rule to the first example, it will break the day you
13151 decide to remove @code{foo_CFLAGS} (because @file{foo.c} will then be
13152 compiled as @file{foo.o} instead of @file{foo-foo.o}, @pxref{Renamed
13153 Objects}). Also in order to support dependency tracking, the two
13154 @file{.o}/@file{.obj} extensions, and all the other flags variables
13155 involved in a compilation, you will end up modifying a copy of the
13156 rule previously output by @command{automake} for this file. If a new
13157 release of Automake generates a different rule, your copy will need to
13158 be updated by hand.
13160 @node Multiple Outputs
13161 @section Handling Tools that Produce Many Outputs
13162 @cindex multiple outputs, rules with
13163 @cindex many outputs, rules with
13164 @cindex rules with multiple outputs
13166 This section describes a @command{make} idiom that can be used when a
13167 tool produces multiple output files. It is not specific to Automake
13168 and can be used in ordinary @file{Makefile}s.
13170 First, however: GNU @command{make} is able to express rules with
13171 multiple output files using pattern rules (@pxref{Pattern Examples, ,
13172 Pattern Rule Examples, make, The GNU Make Manual}). We do not discuss
13173 pattern rules here because they are not portable, but if you're able
13174 to assume GNU @command{make}, they are typically more convenient than
13175 any of the below approaches.
13177 Suppose we have a program called @command{foo} that will read one file
13178 called @file{data.foo} and produce two files named @file{data.c} and
13179 @file{data.h}. We want to write a @file{Makefile} rule that captures
13180 this one-to-two dependency.
13182 The naive rule is incorrect:
13185 # This is incorrect.
13186 data.c data.h: data.foo
13191 What the above rule says is that @file{data.c} and @file{data.h} each
13192 depend on @file{data.foo}, and can each be built by running @samp{foo
13193 data.foo}. In other words it is equivalent to:
13196 # We do not want this.
13204 which means that @command{foo} can be run twice. Usually it will not
13205 be run twice, because @command{make} implementations are smart enough
13206 to check for the existence of the second file after the first one has
13207 been built; they will therefore detect that it already exists.
13208 However there are a few situations where it can run twice anyway:
13212 The most worrying case is when running a parallel @command{make}. If
13213 @file{data.c} and @file{data.h} are built in parallel, two @samp{foo
13214 data.foo} commands will run concurrently. This is harmful.
13216 Another case is when the dependency (here @file{data.foo}) is
13217 (or depends upon) a phony target.
13220 Ideally, we want a scheme that will support any number of output
13221 files, and that works with parallel @command{make} invocations, and
13222 that does nothing when @samp{make -n} is run. It is apparently not
13223 possible to achieve a perfect solution. Even an acceptable solution
13224 for the majority of cases gets complicated, so we will take it step by
13227 One idea is to write the following:
13230 # There is still a problem with this one.
13237 The idea is that @samp{foo data.foo} is run only when @file{data.c}
13238 needs to be updated, but we further state that @file{data.h} depends
13239 upon @file{data.c}. That way, if @file{data.h} is required and
13240 @file{data.foo} is out of date, the dependency on @file{data.c} will
13243 This is almost perfect, but suppose we have built @file{data.h} and
13244 @file{data.c}, and then we erase @file{data.h}. Then, running
13245 @samp{make data.h} will not rebuild @file{data.h}. The above rules
13246 just state that @file{data.c} must be up-to-date with respect to
13247 @file{data.foo}, and this is already the case.
13249 What we need is a rule that forces a rebuild when @file{data.h} is
13250 missing. Here it is:
13253 # More or less works, but not easy to generalize.
13257 ## Recover from the removal of $@@
13258 @@test -f $@@ || rm -f data.c
13259 @@test -f $@@ || $(MAKE) $(AM_MAKEFLAGS) data.c
13262 It is tempting to use a single test as follows:
13265 # This breaks make -n.
13267 ## Recover from the removal of $@@
13268 @@if test -f $@@; then :; else \
13270 $(MAKE) $(AM_MAKEFLAGS) data.c; \
13275 but that would break @samp{make -n}: at least GNU @command{make} and
13276 Solaris @command{make} execute recipes containing the @samp{$(MAKE)}
13277 string even when they are running in dry mode. So if we didn't break
13278 the recipe above in two invocations, the file @file{data.c} would be
13279 removed even upon @samp{make -n}. Not nice.
13282 The above scheme can be extended to handle more outputs and more
13283 inputs. One of the outputs is selected to serve as a witness to the
13284 successful completion of the command, it depends upon all inputs, and
13285 all other outputs depend upon it. For instance, if @command{foo}
13286 should additionally read @file{data.bar} and also produce
13287 @file{data.w} and @file{data.x}, we would write:
13290 data.c: data.foo data.bar
13291 foo data.foo data.bar
13292 data.h data.w data.x: data.c
13293 ## Recover from the removal of $@@
13294 @@test -f $@@ || rm -f data.c
13295 @@test -f $@@ || $(MAKE) $(AM_MAKEFLAGS) data.c
13298 However there are now three problems in this setup. One is related to
13299 the timestamp ordering of @file{data.h}, @file{data.w}, @file{data.x},
13300 and @file{data.c}. A second is a race condition if a parallel
13301 @command{make} attempts to run multiple instances of the recover block
13302 at once. Finally, the recursive rule breaks @samp{make -n} when run
13303 with GNU @command{make} (as well as some other @command{make}
13304 implementations), as it may remove @file{data.h} even when it should
13305 not (@pxref{MAKE Variable, , How the @code{MAKE} Variable Works, make,
13306 The GNU Make Manual}).
13308 Let us deal with the first problem. @command{foo} outputs four files,
13309 but we do not know in which order these files are created. Suppose
13310 that @file{data.h} is created before @file{data.c}. Then we have a
13311 weird situation. The next time @command{make} is run, @file{data.h}
13312 will appear older than @file{data.c}, the second rule will be
13313 triggered, a shell will be started to execute the @samp{if@dots{}fi}
13314 command, but it will just execute the @code{then} branch, that is:
13315 nothing. In other words, because the witness we selected is not the
13316 first file created by @command{foo}, @command{make} will start a shell
13317 to do nothing each time it is run.
13319 A simple riposte is to fix the timestamps when this happens.
13322 data.c: data.foo data.bar
13323 foo data.foo data.bar
13324 data.h data.w data.x: data.c
13325 @@test ! -f $@@ || touch $@@
13326 ## Recover from the removal of $@@
13327 @@test -f $@@ || rm -f data.c
13328 @@test -f $@@ || $(MAKE) $(AM_MAKEFLAGS) data.c
13331 Another solution is to use a different and dedicated file as witness,
13332 rather than using any of @command{foo}'s outputs.
13335 data.stamp: data.foo data.bar
13338 foo data.foo data.bar
13339 @@mv -f data.tmp $@@
13340 data.c data.h data.w data.x: data.stamp
13341 ## Recover from the removal of $@@
13342 @@test -f $@@ || rm -f data.stamp
13343 @@test -f $@@ || $(MAKE) $(AM_MAKEFLAGS) data.stamp
13346 @file{data.tmp} is created before @command{foo} is run, so it has a
13347 timestamp older than output files output by @command{foo}. It is then
13348 renamed to @file{data.stamp} after @command{foo} has run, because we
13349 do not want to update @file{data.stamp} if @command{foo} fails.
13351 This solution still suffers from the second problem: the race
13352 condition in the recover rule. If, after a successful build, a user
13353 erases @file{data.c} and @file{data.h}, and runs @samp{make -j}, then
13354 @command{make} may start both recover rules in parallel. If the two
13355 instances of the rule execute @samp{$(MAKE) $(AM_MAKEFLAGS)
13356 data.stamp} concurrently the build is likely to fail (for instance, the
13357 two rules will create @file{data.tmp}, but only one can rename it).
13359 Admittedly, such a weird situation does not arise during ordinary
13360 builds. It occurs only when the build tree is mutilated. Here
13361 @file{data.c} and @file{data.h} have been explicitly removed without
13362 also removing @file{data.stamp} and the other output files.
13363 @code{make clean; make} will always recover from these situations even
13364 with parallel makes, so you may decide that the recover rule is solely
13365 to help non-parallel make users and leave things as-is. Fixing this
13366 requires some locking mechanism to ensure only one instance of the
13367 recover rule rebuilds @file{data.stamp}. One could imagine something
13368 along the following lines.
13371 data.c data.h data.w data.x: data.stamp
13372 ## Recover from the removal of $@@
13373 @@if test -f $@@; then :; else \
13374 trap 'rm -rf data.lock data.stamp' 1 2 13 15; \
13375 ## mkdir is a portable test-and-set
13376 if mkdir data.lock 2>/dev/null; then \
13377 ## This code is being executed by the first process.
13378 rm -f data.stamp; \
13379 $(MAKE) $(AM_MAKEFLAGS) data.stamp; \
13380 result=$$?; rm -rf data.lock; exit $$result; \
13382 ## This code is being executed by the follower processes.
13383 ## Wait until the first process is done.
13384 while test -d data.lock; do sleep 1; done; \
13385 ## Succeed if and only if the first process succeeded.
13386 test -f data.stamp; \
13391 Using a dedicated witness, like @file{data.stamp}, is very handy when
13392 the list of output files is not known beforehand. As an illustration,
13393 consider the following rules to compile many @file{*.el} files into
13394 @file{*.elc} files in a single command. It does not matter how
13395 @code{ELFILES} is defined (as long as it is not empty: empty targets
13396 are not accepted by POSIX).
13399 ELFILES = one.el two.el three.el @dots{}
13400 ELCFILES = $(ELFILES:=c)
13402 elc-stamp: $(ELFILES)
13405 $(elisp_comp) $(ELFILES)
13406 @@mv -f elc-temp $@@
13408 $(ELCFILES): elc-stamp
13409 @@if test -f $@@; then :; else \
13410 ## Recover from the removal of $@@
13411 trap 'rm -rf elc-lock elc-stamp' 1 2 13 15; \
13412 if mkdir elc-lock 2>/dev/null; then \
13413 ## This code is being executed by the first process.
13415 $(MAKE) $(AM_MAKEFLAGS) elc-stamp; \
13418 ## This code is being executed by the follower processes.
13419 ## Wait until the first process is done.
13420 while test -d elc-lock; do sleep 1; done; \
13421 ## Succeed if and only if the first process succeeded.
13422 test -f elc-stamp; exit $$?; \
13428 These solutions all still suffer from the third problem, namely that
13429 they break the promise that @samp{make -n} should not cause any actual
13430 changes to the tree. For those solutions that do not create lock files,
13431 it is possible to split the recover rules into two separate recipe
13432 commands, one of which does all work but the recursion, and the
13433 other invokes the recursive @samp{$(MAKE)}. The solutions involving
13434 locking could act upon the contents of the @samp{MAKEFLAGS} variable,
13435 but parsing that portably is not easy (@pxref{The Make Macro MAKEFLAGS,,,
13436 autoconf, The Autoconf Manual}). Here is an example:
13439 ELFILES = one.el two.el three.el @dots{}
13440 ELCFILES = $(ELFILES:=c)
13442 elc-stamp: $(ELFILES)
13445 $(elisp_comp) $(ELFILES)
13446 @@mv -f elc-temp $@@
13448 $(ELCFILES): elc-stamp
13449 ## Recover from the removal of $@@
13450 @@dry=; for f in x $$MAKEFLAGS; do \
13456 if test -f $@@; then :; else \
13457 $$dry trap 'rm -rf elc-lock elc-stamp' 1 2 13 15; \
13458 if $$dry mkdir elc-lock 2>/dev/null; then \
13459 ## This code is being executed by the first process.
13460 $$dry rm -f elc-stamp; \
13461 $(MAKE) $(AM_MAKEFLAGS) elc-stamp; \
13462 $$dry rmdir elc-lock; \
13464 ## This code is being executed by the follower processes.
13465 ## Wait until the first process is done.
13466 while test -d elc-lock && test -z "$$dry"; do \
13470 ## Succeed if and only if the first process succeeded.
13471 $$dry test -f elc-stamp; exit $$?; \
13477 @node Hard-Coded Install Paths
13478 @section Installing to Hard-Coded Locations
13481 My package needs to install some configuration file. I tried to use
13482 the following rule, but @samp{make distcheck} fails. Why?
13486 install-data-local:
13487 $(INSTALL_DATA) $(srcdir)/afile $(DESTDIR)/etc/afile
13492 My package needs to populate the installation directory of another
13493 package at install-time. I can easily compute that installation
13494 directory in @file{configure}, but if I install files therein,
13495 @samp{make distcheck} fails. How else should I do it?
13498 These two setups share their symptoms: @samp{make distcheck} fails
13499 because they are installing files to hard-coded paths. In the latter
13500 case the path is not hard-coded in the package, but we can consider it
13501 to be hard-coded in the system (or in whichever tool that supplies the
13502 path). As long as the path does not use any of the standard directory
13503 variables (@samp{$(prefix)}, @samp{$(bindir)}, @samp{$(datadir)},
13504 etc.), the effect will be the same: user-installations are impossible.
13506 As a (non-root) user who wants to install a package, you usually have no
13507 right to install anything in @file{/usr} or @file{/usr/local}. So you
13508 do something like @samp{./configure --prefix ~/usr} to install a
13509 package in your own @file{~/usr} tree.
13511 If a package attempts to install something to some hard-coded path
13512 (e.g., @file{/etc/afile}), regardless of this @option{--prefix} setting,
13513 then the installation will fail. @samp{make distcheck} performs such
13514 a @option{--prefix} installation, hence it will fail too.
13516 Now, there are some easy solutions.
13518 The above @code{install-data-local} example for installing
13519 @file{/etc/afile} would be better replaced by
13522 sysconf_DATA = afile
13526 By default @code{sysconfdir} will be @samp{$(prefix)/etc}, because
13527 this is what the GNU Standards require. When such a package is
13528 installed on an FHS compliant system, the installer will have to set
13529 @samp{--sysconfdir=/etc}. As the maintainer of the package you
13530 should not be concerned by such site policies: use the appropriate
13531 standard directory variable to install your files so that the installer
13532 can easily redefine these variables to match their site conventions.
13534 Installing files that should be used by another package is slightly
13535 more involved. Let's take an example and assume you want to install
13536 a shared library that is a Python extension module. If you ask Python
13537 where to install the library, it will answer something like this:
13540 % @kbd{python -c 'from distutils import sysconfig;
13541 print sysconfig.get_python_lib(1,0)'}
13542 /usr/lib/python2.5/site-packages
13545 If you indeed use this absolute path to install your shared library,
13546 non-root users will not be able to install the package; hence
13549 Let's do better. The @samp{sysconfig.get_python_lib()} function
13550 accepts a third argument that will replace Python's installation
13554 % @kbd{python -c 'from distutils import sysconfig;
13555 print sysconfig.get_python_lib(1,0,"$@{exec_prefix@}")'}
13556 $@{exec_prefix@}/lib/python2.5/site-packages
13559 You can also use this new path. If you do
13562 root users can install your package with the same @option{--prefix}
13563 as Python (you get the behavior of the previous attempt)
13566 non-root users can install your package too; they will have the
13567 extension module in a place that is not searched by Python but they
13568 can work around this using environment variables (and if you installed
13569 scripts that use this shared library, it's easy to tell Python where to
13570 look in the beginning of your script, so the script works in both
13574 The @code{AM_PATH_PYTHON} macro uses similar commands to define
13575 @samp{$(pythondir)} and @samp{$(pyexecdir)} (@pxref{Python}).
13577 Of course not all tools are as advanced as Python regarding that
13578 substitution of @var{prefix}. So another strategy is to figure out the
13579 part of the installation directory that must be preserved. For
13580 instance, here is how @code{AM_PATH_LISPDIR} (@pxref{Emacs Lisp})
13581 computes @samp{$(lispdir)}:
13584 $EMACS -batch -no-site-file -eval '(while load-path
13585 (princ (concat (car load-path) "\n"))
13586 (setq load-path (cdr load-path)))' >conftest.out
13589 -e '/.*\/lib\/x*emacs\/site-lisp$/@{
13590 s,.*/lib/\(x*emacs/site-lisp\)$,$@{libdir@}/\1,;p;q;
13592 -e '/.*\/share\/x*emacs\/site-lisp$/@{
13593 s,.*/share/\(x*emacs/site-lisp\),$@{datarootdir@}/\1,;p;q;
13598 That is, it just picks the first directory that looks like
13599 @file{*/lib/*emacs/site-lisp} or @file{*/share/*emacs/site-lisp} in
13600 the search path of emacs, and then substitutes @samp{$@{libdir@}} or
13601 @samp{$@{datadir@}} appropriately.
13603 The emacs case looks complicated because it processes a list and
13604 expects two possible layouts; otherwise it's easy, and the benefits
13605 for non-root users are worth the extra @command{sed} invocation.
13608 @node Debugging Make Rules
13609 @section Debugging Make Rules
13610 @cindex debugging rules
13611 @cindex rules, debugging
13613 The rules and dependency trees generated by @command{automake} can get
13614 rather complex, and leave the developer head-scratching when things
13615 don't work as expected. Besides the debug options provided by the
13616 @command{make} command (@pxref{Options Summary,,, make, The GNU Make
13617 Manual}), here's a couple of further hints for debugging makefiles
13618 generated by @command{automake} effectively:
13622 If less verbose output has been enabled in the package with the use
13623 of silent rules (@pxref{Automake Silent Rules}), you can use
13624 @code{make V=1} to see the commands being executed.
13627 @code{make -n} can help show what would be done without actually doing
13628 it. However, this @emph{still executes} commands prefixed with
13629 @samp{+}, and, when using GNU @command{make}, commands that contain
13630 the strings @samp{$(MAKE)} or @samp{$@{MAKE@}} (@pxref{Instead of
13631 Execution,,, make, The GNU Make Manual}). Typically, this is helpful
13632 to show what recursive rules would do, but it means that, in your own
13633 rules, you should not mix such recursion with actions that change any
13634 files.@footnote{Automake's @samp{dist} and @samp{distcheck} rules had
13635 a bug in this regard in that they created directories even with
13636 @option{-n}, but this has been fixed in Automake 1.11.} Furthermore,
13637 note that GNU @command{make} will update prerequisites for the
13638 @file{Makefile} file itself even with @option{-n} (@pxref{Remaking
13639 Makefiles,,, make, The GNU Make Manual}).
13642 @code{make SHELL="/bin/bash -vx"} can help debug complex rules.
13643 @xref{The Make Macro SHELL,,, autoconf, The Autoconf Manual}, for some
13644 portability quirks associated with this construct.
13647 @code{echo 'print: ; @@echo "$(VAR)"' | make -f Makefile -f - print}
13648 can be handy to examine the expanded value of variables. You may need
13649 to use a target other than @samp{print} if that is already used or a
13650 file with that name exists.
13653 @url{http://bashdb.sourceforge.net/@/remake/} provides a modified
13654 GNU @command{make} command called @command{remake} that copes with
13655 complex GNU @command{make}-specific Makefiles and allows tracing
13656 execution, examining variables, and calling rules interactively, much like
13661 @node Reporting Bugs
13662 @section Reporting Bugs
13664 @cindex Bugs, reporting
13665 @cindex Reporting bugs
13667 Most nontrivial software has bugs. Automake is no exception. We
13668 cannot promise we can or will fix a bug, and we might not even agree
13669 that it is a bug, but we want to hear about problems you
13670 encounter. Often we agree they are bugs and want to fix them.
13672 So, to make it possible for us to fix a bug, please report it.
13673 If you can, though, it is helpful if you check if it is already known.
13674 You can look at the @uref{https://debbugs.gnu.org/, GNU Bug Tracker}
13675 and the @uref{https://lists.gnu.org/@/archive/@/html/@/bug-automake/,
13676 bug-automake mailing list archives} for previous bug reports. (We
13677 previously used a Gnats database for bug tracking, but it is no longer
13680 If the bug is not already known, it should be reported. To report
13681 bugs in a way that is useful and efficient, please read
13682 @uref{https://www.chiark.greenend.org.uk/@/~sgtatham/@/bugs.html, How
13683 to Report Bugs Effectively} and
13684 @uref{http://catb.org/@/~esr/@/faqs/@/smart-questions.html, How to Ask
13685 Questions the Smart Way}. Good bug reports save time for everyone.
13687 For a bug report, a feature request or other suggestions, please send
13688 email to @email{@value{PACKAGE_BUGREPORT}}. This will then open a new
13689 bug in the @uref{https://debbugs.gnu.org/@/automake, bug tracker}. Be
13690 sure to include the versions of Autoconf and Automake that you use and
13691 the kind of system you're on. Ideally, post a minimal
13692 @file{Makefile.am} and @file{configure.ac} that reproduces the problem
13693 you encounter. If you have encountered test suite failures, please
13694 attach the @file{test-suite.log} file.
13696 @c ========================================================== Appendices
13699 @node Copying This Manual
13700 @appendix Copying This Manual
13703 * GNU Free Documentation License:: License for copying this manual
13706 @node GNU Free Documentation License
13707 @appendixsec GNU Free Documentation License
13715 * Macro Index:: Index of Autoconf macros
13716 * Variable Index:: Index of Makefile variables
13717 * General Index:: General index
13721 @appendixsec Macro Index
13725 @node Variable Index
13726 @appendixsec Variable Index
13730 @node General Index
13731 @appendixsec General Index
13738 @c LocalWords: texinfo setfilename settitle setchapternewpage texi direntry
13739 @c LocalWords: dircategory in's aclocal ifinfo titlepage Tromey vskip pt sp
13740 @c LocalWords: filll defcodeindex ov cv op tr syncodeindex fn cp vr ifnottex
13741 @c LocalWords: dir Automake's ac Dist Gnits gnits dfn Autoconf's pxref
13742 @c LocalWords: cindex Autoconf autoconf perl samp cvs dist trindex SUBST foo
13743 @c LocalWords: xs emph FIXME ref vindex pkglibdir pkgincludedir pkgdatadir mt
13744 @c LocalWords: pkg libdir cpio bindir sbindir rmt pax sbin zar zardir acindex
13745 @c LocalWords: HTML htmldir html noinst TEXINFOS nodist nobase strudel CFLAGS
13746 @c LocalWords: libmumble CC YFLAGS itemx de fication config url comp
13747 @c LocalWords: depcomp elisp sh mdate mkinstalldirs mkdir py tex dvi ps pdf
13748 @c LocalWords: ylwrap zardoz INIT gettext acinclude mv FUNCS LIBOBJS LDADD fr
13749 @c LocalWords: uref featureful dnl src LINGUAS es ko nl pl sl sv PROG ISC doc
13750 @c LocalWords: POSIX STDC fcntl FUNC ALLOCA blksize struct stat intl po chmod
13751 @c LocalWords: ChangeLog SUBDIRS gettextize gpl testdata getopt INTLLIBS cpp
13752 @c LocalWords: localedir datadir DLOCALEDIR DEXIT CPPFLAGS autoreconf opindex
13753 @c LocalWords: AUX var symlink deps Wno Wnone package's aclocal's distclean
13754 @c LocalWords: ltmain xref LIBSOURCE LIBSOURCES LIBOBJ MEMCMP vs RANLIB CXX
13755 @c LocalWords: LDFLAGS LIBTOOL libtool XTRA LIBS gettext's acdir APIVERSION
13756 @c LocalWords: dirlist noindent usr TIOCGWINSZ sc
13757 @c LocalWords: GWINSZ termios SRCDIR tarball bzip LISPDIR lispdir XEmacs CCAS
13758 @c LocalWords: emacsen MicroEmacs CCASFLAGS UX GCJ gcj GCJFLAGS posix DMALLOC
13759 @c LocalWords: dmalloc ldmalloc REGEX regex DEPDIR DEP DEFUN aclocaldir fi
13760 @c LocalWords: mymacro myothermacro AMFLAGS autopoint autogen libtoolize yum
13761 @c LocalWords: autoheader README MAKEFLAGS subdir Inetutils sync COND endif
13762 @c LocalWords: Miller's installable includedir inc pkgdata EXEEXT libexec bsd
13763 @c LocalWords: pkglib libexecdir prog libcpio cpio's dlopen dlpreopen linux
13764 @c LocalWords: subsubsection OBJEXT esac lib LTLIBRARIES liblob LIBADD AR ar
13765 @c LocalWords: ARFLAGS cr ing maude libgettext lo LTLIBOBJS rpath SGI PRE yy
13766 @c LocalWords: libmaude CCLD CXXFLAGS FFLAGS LFLAGS OBJCFLAGS RFLAGS DEFS cc
13767 @c LocalWords: OBJCXXFLAGS
13768 @c LocalWords: SHORTNAME vtable srcdir nostdinc basename yxx cxx ll lxx gdb
13769 @c LocalWords: lexers yymaxdepth maxdepth yyparse yylex yyerror yylval lval
13770 @c LocalWords: yychar yydebug yypact yyr yydef def yychk chk yypgo pgo yyact
13771 @c LocalWords: yyexca exca yyerrflag errflag yynerrs nerrs yyps yypv pv yys
13772 @c LocalWords: yystate yytmp tmp yyv yyval val yylloc lloc yyreds yytoks toks
13773 @c LocalWords: yylhs yylen yydefred yydgoto yysindex yyrindex yygindex yyname
13774 @c LocalWords: yytable yycheck yyrule byacc CXXCOMPILE CXXLINK FLINK cfortran
13775 @c LocalWords: Catalogue preprocessable FLIBS libfoo baz JAVACFLAGS java exe
13776 @c LocalWords: SunOS fying basenames exeext uninstalled oldinclude kr FSF's
13777 @c LocalWords: pkginclude oldincludedir sysconf sharedstate localstate gcc rm
13778 @c LocalWords: sysconfdir sharedstatedir localstatedir preexist CLEANFILES gz
13779 @c LocalWords: depfile tmpdepfile depmode const interoperate
13780 @c LocalWords: JAVAC javac JAVAROOT builddir CLASSPATH ENV pyc pyo pkgpython
13781 @c LocalWords: pyexecdir pkgpyexecdir Python's pythondir pkgpythondir txi ois
13782 @c LocalWords: installinfo vers MAKEINFO makeinfo MAKEINFOFLAGS noinstall rf
13783 @c LocalWords: mandir thesame alsothesame installman myexecbin DESTDIR Pinard
13784 @c LocalWords: uninstall installdirs uninstalls MOSTLYCLEANFILES mostlyclean
13785 @c LocalWords: DISTCLEANFILES MAINTAINERCLEANFILES GZIP gzip shar exp
13786 @c LocalWords: distdir distcheck distcleancheck listfiles distuninstallcheck
13787 @c LocalWords: VPATH tarfile stdout XFAIL DejaGnu dejagnu DEJATOOL runtest ln
13788 @c LocalWords: RUNTESTDEFAULTFLAGS toolchain RUNTESTFLAGS asis readme DVIPS
13789 @c LocalWords: installcheck gzipped tarZ std utils etags mkid cd
13790 @c LocalWords: ARGS taggable ETAGSFLAGS lang ctags CTAGSFLAGS GTAGS gtags idl
13791 @c LocalWords: foocc doit idlC multilibs ABIs cmindex defmac ARG enableval FC
13792 @c LocalWords: MSG xtrue DBG pathchk CYGWIN afile proglink versioned CVS's TE
13793 @c LocalWords: wildcards Autoconfiscated subsubheading autotools Meyering API
13794 @c LocalWords: ois's wildcard Wportability cartouche vrindex printindex Duret
13795 @c LocalWords: DSOMEFLAG DVERSION automake Lutz insertcopying versioning FAQ
13796 @c LocalWords: LTLIBOBJ Libtool's libtool's libltdl dlopening itutions libbar
13797 @c LocalWords: WANTEDLIBS libhello sublibraries libtop libsub dlopened Ratfor
13798 @c LocalWords: mymodule timestamps timestamp underquoted MAKEINFOHTMLFLAGS te
13799 @c LocalWords: GNUmakefile Subpackages subpackage's subpackages aux
13800 @c LocalWords: detailmenu Timeline pwd reldir AUTOM autom PREREQ FOOBAR libc
13801 @c LocalWords: libhand subpackage moduleN libmain libmisc FCFLAGS FCCOMPILE
13802 @c LocalWords: FCLINK subst sed ELCFILES elc MAKEINFOHTML dvips esyscmd ustar
13803 @c LocalWords: tarballs Woverride vfi ELFILES djm AutoMake honkin FSF
13804 @c LocalWords: fileutils precanned MacKenzie's reimplement termutils Tromey's
13805 @c LocalWords: cois gnitsians LIBPROGRAMS progs LIBLIBRARIES Textutils Ulrich
13806 @c LocalWords: Matzigkeit Drepper's Gord Matzigkeit's jm Dalley Debian org
13807 @c LocalWords: Administrivia ILU CORBA Sourceware Molenda sourceware Elliston
13808 @c LocalWords: dep Oliva Akim Demaille Aiieeee Demaillator Akim's sourcequake
13809 @c LocalWords: grep backported screenshots libgcj KB unnumberedsubsubsec pre
13810 @c LocalWords: precomputing hacky makedepend inline clearmake LD PRELOAD Rel
13811 @c LocalWords: syscalls perlhist acl pm multitable headitem fdl appendixsec
13812 @c LocalWords: LTALLOCA MALLOC malloc memcmp strdup alloca libcompat xyz DFOO
13813 @c LocalWords: unprefixed buildable preprocessed DBAZ DDATADIR WARNINGCFLAGS
13814 @c LocalWords: LIBFOOCFLAGS LIBFOOLDFLAGS ftable testSubDir obj LIBTOOLFLAGS
13815 @c LocalWords: barexec Pinard's automatize initialize lzip xz zstd cscope