summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorStefano Lattarini <stefano.lattarini@gmail.com>2014-12-19 13:09:39 +0100
committerStefano Lattarini <stefano.lattarini@gmail.com>2014-12-19 13:27:34 +0100
commit78964087335e66e9ae4ad3899bd545b770e30581 (patch)
treec7d54a7a97e2bdde966d14fbb3c1c176a341e306 /doc
parent3f9fc60baa2e7f9324e17a26f592e92148b7117c (diff)
parentcaba6a20804021ab607b40ccefece4e77ef72a77 (diff)
downloadautomake-78964087335e66e9ae4ad3899bd545b770e30581.tar.gz
Merge branch 'micro' into minor
* micro: sync: update third-part files from upstream Make sure AM_INIT_AUTOMAKE has a trailing newline dist: adjust warning messages about shar and tarZ deprecation docs: improve description of ${PACKAGE}, ${VERSION}, and similar variables Signed-off-by: Stefano Lattarini <stefano.lattarini@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/automake.texi31
1 files changed, 21 insertions, 10 deletions
diff --git a/doc/automake.texi b/doc/automake.texi
index 9680d21c7..54f3bb3c0 100644
--- a/doc/automake.texi
+++ b/doc/automake.texi
@@ -3911,12 +3911,15 @@ This usage is mostly obsolete because the @var{package} and @var{version}
can be obtained from Autoconf's @code{AC_INIT} macro. However,
differently from what happens for @code{AC_INIT} invocations, this
@code{AM_INIT_AUTOMAKE} invocation supports shell variables' expansions
-in the @code{PACKAGE} and @code{VERSION} arguments, and this can be
-still be useful in some selected situations. Our hope is that future
-Autoconf versions will improve their support for package versions
-defined dynamically at configure runtime; when (and if) this happens,
-support for the two-args @code{AM_INIT_AUTOMAKE} invocation will likely
-be removed from Automake.
+in the @code{PACKAGE} and @code{VERSION} arguments (which otherwise
+defaults, respectively, to the @code{PACKAGE_TARNAME} and
+@code{PACKAGE_VERSION} defined via the @code{AC_INIT} invocation;
+@pxref{AC_INIT, , The @code{AC_INIT} macro, autoconf, The Autoconf Manual});
+and this can be still be useful in some selected situations.
+Our hope is that future Autoconf versions will improve their support
+for package versions defined dynamically at configure runtime; when
+(and if) this happens, support for the two-args @code{AM_INIT_AUTOMAKE}
+invocation will likely be removed from Automake.
@anchor{Modernize AM_INIT_AUTOMAKE invocation}
If your @file{configure.ac} has:
@@ -8380,9 +8383,13 @@ We recommend that you follow this same set of heuristics in your
The @code{dist} rule in the generated @file{Makefile.in} can be used
to generate a gzipped @code{tar} file and other flavors of archive for
distribution. The file is named based on the @code{PACKAGE} and
-@code{VERSION} variables defined by @code{AM_INIT_AUTOMAKE}
-(@pxref{Macros}); more precisely the gzipped @code{tar} file is named
-@samp{@var{package}-@var{version}.tar.gz}.
+@code{VERSION} variables automatically defined by either the
+@code{AC_INIT} invocation or by a @emph{deprecated} two-arguments
+invocation of the @code{AM_INIT_AUTOMAKE} macro (see @ref{Public Macros}
+for how these variables get their values, from either defaults or explicit
+values -- it's slightly trickier than one would expect).
+More precisely the gzipped @code{tar} file is named
+@samp{$@{PACKAGE@}-$@{VERSION@}.tar.gz}.
@vindex GZIP_ENV
You can use the @command{make} variable @code{GZIP_ENV} to control how gzip
is run. The default setting is @option{--best}.
@@ -10134,7 +10141,11 @@ brittle.
@opindex no-define
This option is meaningful only when passed as an argument to
@code{AM_INIT_AUTOMAKE}. It will prevent the @code{PACKAGE} and
-@code{VERSION} variables from being @code{AC_DEFINE}d.
+@code{VERSION} variables from being @code{AC_DEFINE}d. But notice
+that they will remain defined as shell variables in the generated
+@code{configure}, and as make variables in the generated
+@code{Makefile}; this is deliberate, and required for backward
+compatibility.
@item @option{no-dependencies}
@cindex Option, @option{no-dependencies}