GNU bug report logs - #7766
docs: work on index issues

Previous Next

Full log

View this message in rfc822 format

From: Ralf Wildenhues <Ralf.Wildenhues <at> gmx.de>
To: Karl Berry <karl <at> freefriends.org>, automake-patches <at> gnu.org
Cc: 7766 <at> debbugs.gnu.org
Subject: bug#7766: (lack of) config.h description in manual
Date: Sat, 8 Jan 2011 20:21:29 +0100

Hi Karl,

* Karl Berry wrote on Sat, Jan 01, 2011 at 01:00:20AM CET:
> Finally, the "amhello explained" node is pretty long.  It seems to break
> up naturally into three pieces, for each of the files being explained.
> Perhaps it would be good to make them each separate (sub)nodes.

Hmm, I see a natural split into two, not three nodes.  Below, I replaced
the existing one rather than using another lower hierarchy level.  Does
this seem acceptable to you?

Thanks,
Ralf

    docs: split 'amhello Explained' node.
    
    * doc/automake.texi (amhello Explained): Split node ...
    (amhello/configure.ac, amhello/Makefile.am): ... into these two.
    (Top, Hello World): Adjust, and add @anchor for stable URL links.
    Suggestion by Karl Berry in automake bug#7766.

diff --git a/doc/automake.texi b/doc/automake.texi
index c63dbf3..9e29951 100644
--- a/doc/automake.texi
+++ b/doc/automake.texi
@@ -157,7 +157,8 @@ Top
 A Small Hello World
 
 * Creating amhello::            Create @file{amhello-1.0.tar.gz} from scratch
-* amhello Explained::           @file{configure.ac} and @file{Makefile.am} explained
+* amhello/configure.ac::        Configure setup explained
+* amhello/Makefile.am::         Makefile setup explained
 
 General ideas
 
@@ -1392,9 +1393,11 @@ Hello World
 meaning of the @file{configure.ac} and @file{Makefile.am} files read
 by the Autotools.
 
+@anchor{amhello Explained}
 @menu
 * Creating amhello::            Create @file{amhello-1.0.tar.gz} from scratch
-* amhello Explained::           @file{configure.ac} and @file{Makefile.am} explained
+* amhello/configure.ac::        Configure setup explained
+* amhello/Makefile.am::         Makefile setup explained
 @end menu
 
 @node Creating amhello
@@ -1555,8 +1558,10 @@ Creating amhello
 direct you to the right manual when seeking answers.
 
 
-@node amhello Explained
-@subsection @file{amhello-1.0} Explained
+@node amhello/configure.ac
+@subsection Configure setup explained
+
+@cindex @file{configure.ac}, Hello World
 
 Let us begin with the contents of @file{configure.ac}.
 
@@ -1664,6 +1669,10 @@ amhello Explained
 @command{autoscan} to Create @file{configure.ac}, autoconf, The
 Autoconf Manual}).
 
+
+@node amhello/Makefile.am
+@subsection Makefile setup explained
+
 @cindex @file{Makefile.am}, Hello World
 
 We now turn to @file{src/Makefile.am}.  This file contains

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.