From: Stefano Lattarini <stefano.lattarini@gmail.com>
Date: Mon, 26 Dec 2011 19:08:23 +0000 (+0100)
Subject: docs: fix node names for automake and aclocal invocations
X-Git-Tag: v1.11.2b~16^2~3
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b1b43854dfcb2419bfd5c725aebc42b866374b75;p=thirdparty%2Fautomake.git

docs: fix node names for automake and aclocal invocations

With the older node names, an "info automake" command issued
from the command line would have opened the node about the
invocation of the automake program, rather than the Top node
of the automake documentation.  To invoke the Top node, one
had to issue the command "info Automake" instead (note the
different capitalization).  This was suboptimal, and certainly
confusing.

With this change, "info automake" will open the Top node of the
automake documentation; to access the nodes about the invocation
of the automake and aclocal program, one has now to issue "info
automake-invocation" and "info aclocal-invocation" respectively.

This change fixes automake bug#8071.

See also commits `v2.61a-22-ge9215d1' and `v2.61a-72-g8c07b48' in
the autoconf git repository, which tackled a similar issue.

* doc/automake.texi (@direntry): Rename nodes `aclocal' and
`automake' to `aclocal-invocation' and `automake-invocation'
respectively.
* NEWS: Update.
---

diff --git a/ChangeLog b/ChangeLog
index 86a761d17..412d4d6b8 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,30 @@
+2011-12-26  Stefano Lattarini  <stefano.lattarini@gmail.com>
+
+	docs: fix node names for automake and aclocal invocations
+
+	With the older node names, an "info automake" command issued
+	from the command line would have opened the node about the
+	invocation of the automake program, rather than the Top node
+	of the automake documentation.  To invoke the Top node, one
+	had to issue the command "info Automake" instead (note the
+	different capitalization).  This was suboptimal, and certainly
+	confusing.
+
+	With this change, "info automake" will open the Top node of the
+	automake documentation; to access the nodes about the invocation
+	of the automake and aclocal program, one has now to issue "info
+	automake-invocation" and "info aclocal-invocation" respectively.
+
+	This change fixes automake bug#8071.
+
+	See also commits `v2.61a-22-ge9215d1' and `v2.61a-72-g8c07b48' in
+	the autoconf git repository, which tackled a similar issue.
+
+	* doc/automake.texi (@direntry): Rename nodes `aclocal' and
+	`automake' to `aclocal-invocation' and `automake-invocation'
+	respectively.
+	* NEWS: Update.
+
 2011-12-24  Stefano Lattarini  <stefano.lattarini@gmail.com>
 
 	gitignore: use only one .gitignore file, in the top-level directory
diff --git a/NEWS b/NEWS
index db448a913..f6eb29f1a 100644
--- a/NEWS
+++ b/NEWS
@@ -28,6 +28,12 @@ New in 1.11.0a:
 
 * Miscellaneous changes:
 
+  - In the Automake info documentation, the Top node and the nodes about
+    the invocation of the automake and aclocal programs have been renamed;
+    now, calling "info automake" will open the Top node, while calling
+    "info automake-invocation" and "info aclocal-invocation" will access
+    the nodes about the invocation of respectively automake and aclocal.
+
   - Automake is now distributed as a gzip-compressed and an xz-compressed
     tarball.  Previously, bzip2 was used instead of xz.
 
diff --git a/doc/automake.texi b/doc/automake.texi
index ced1b72fd..31516202b 100644
--- a/doc/automake.texi
+++ b/doc/automake.texi
@@ -38,9 +38,6 @@ section entitled ``GNU Free Documentation License.''
 @end quotation
 @end copying
 
-@c info Automake  points to the Automake package's documentation
-@c info automake  points to the automake script's documentation
-@c (Autoconf has a similar setup.)
 @dircategory Software development
 @direntry
 * Automake: (automake).         Making GNU standards-compliant Makefiles.
@@ -48,8 +45,8 @@ section entitled ``GNU Free Documentation License.''
 
 @dircategory Individual utilities
 @direntry
-* aclocal: (automake)Invoking aclocal.          Generating aclocal.m4.
-* automake: (automake)Invoking Automake.        Generating Makefile.in.
+* aclocal-invocation: (automake)Invoking aclocal.    Generating aclocal.m4.
+* automake-invocation: (automake)Invoking Automake.  Generating Makefile.in.
 @end direntry
 
 @titlepage