Move position of @contents

Move position of @contents

[Richard Sandiford]

At the moment, the printed versions of most manuals (all except
libiberty) explicitly put the table of contents at the very end of
the document, after the index and (where used) the page containing
typesetting information.  This is at odds with most (although admittedly
not all) manuals I've seen, and is also at odds with the gcc manual.
It seems more common for the contents to go after the title page and
for the index to go at the end.

This patch puts the contents after the title page instead.
Tested with "make info", "make html" and "make pdf".  OK to install?

Richard


bfd/
200x-xx-xx  Richard Sandiford  <richard@codesourcery.com>
	    Phil Edwards  <phil@codesourcery.com>

	* doc/bfd.texinfo: Put the contents after the title page rather
	than at the end of the document.

binutils/
200x-xx-xx  Richard Sandiford  <richard@codesourcery.com>
	    Phil Edwards  <phil@codesourcery.com>

	* doc/binutils.texi: Put the contents after the title page rather
	than at the end of the document.

gas/
200x-xx-xx  Richard Sandiford  <richard@codesourcery.com>
	    Phil Edwards  <phil@codesourcery.com>

	* doc/as.texinfo: Put the contents after the title page rather
	than at the end of the document.

gprof/
200x-xx-xx  Richard Sandiford  <richard@codesourcery.com>
	    Phil Edwards  <phil@codesourcery.com>

	* gprof.texi: Put the contents after the title page rather
	than at the end of the document.

ld/
200x-xx-xx  Richard Sandiford  <richard@codesourcery.com>
	    Phil Edwards  <phil@codesourcery.com>

	* ld.texinfo: Put the contents after the title page rather
	than at the end of the document.

Index: bfd/doc/bfd.texinfo
===================================================================
RCS file: /cvs/src/src/bfd/doc/bfd.texinfo,v
retrieving revision 1.13
diff -u -p -r1.13 bfd.texinfo
--- bfd/doc/bfd.texinfo	24 Jul 2006 13:49:48 -0000	1.13
+++ bfd/doc/bfd.texinfo	23 Mar 2007 16:20:12 -0000
@@ -73,6 +73,7 @@ Copyright @copyright{} 1991, 2001, 2003,
 
 @end titlepage
 @end iftex
+@contents
 
 @node Top, Overview, (dir), (dir)
 @ifinfo
@@ -333,5 +334,4 @@ All of BFD lives in one directory.
 % Blame: doc@cygnus.com, 28mar91.
 @end tex
 
-@contents
 @bye
Index: binutils/doc/binutils.texi
===================================================================
RCS file: /cvs/src/src/binutils/doc/binutils.texi,v
retrieving revision 1.103
diff -u -p -r1.103 binutils.texi
--- binutils/doc/binutils.texi	22 Mar 2007 21:18:31 -0000	1.103
+++ binutils/doc/binutils.texi	23 Mar 2007 16:20:14 -0000
@@ -97,6 +97,7 @@ Copyright @copyright{} 1991, 1992, 1993,
       section entitled ``GNU Free Documentation License''.
 
 @end titlepage
+@contents
 
 @node Top
 @top Introduction
@@ -3947,5 +3948,4 @@ things without first using the debugger 
 
 @printindex cp
 
-@contents
 @bye
Index: gas/doc/as.texinfo
===================================================================
RCS file: /cvs/src/src/gas/doc/as.texinfo,v
retrieving revision 1.160
diff -u -p -r1.160 as.texinfo
--- gas/doc/as.texinfo	22 Mar 2007 21:18:31 -0000	1.160
+++ gas/doc/as.texinfo	23 Mar 2007 16:20:16 -0000
@@ -169,6 +169,7 @@ Copyright @copyright{} 1991, 92, 93, 94,
       section entitled ``GNU Free Documentation License''.
 
 @end titlepage
+@contents
 
 @ifnottex
 @node Top
@@ -6890,7 +6891,6 @@ intentionally leaving anyone out.
 
 @printindex cp
 
-@contents
 @bye
 @c Local Variables:
 @c fill-column: 79
Index: gprof/gprof.texi
===================================================================
RCS file: /cvs/src/src/gprof/gprof.texi,v
retrieving revision 1.22
diff -u -p -r1.22 gprof.texi
--- gprof/gprof.texi	22 Mar 2007 21:18:31 -0000	1.22
+++ gprof/gprof.texi	23 Mar 2007 16:20:17 -0000
@@ -74,6 +74,7 @@ Copyright @copyright{} 1988, 92, 97, 98,
       section entitled ``GNU Free Documentation License''.
 
 @end titlepage
+@contents
 
 @ifnottex
 @node Top
@@ -2574,7 +2575,6 @@ recommend releasing these examples in pa
 free software license, such as the GNU General Public License,
 to permit their use in free software.
 
-@contents
 @bye
 
 NEEDS AN INDEX
Index: ld/ld.texinfo
===================================================================
RCS file: /cvs/src/src/ld/ld.texinfo,v
retrieving revision 1.189
diff -u -p -r1.189 ld.texinfo
--- ld/ld.texinfo	22 Mar 2007 21:18:34 -0000	1.189
+++ ld/ld.texinfo	23 Mar 2007 16:20:19 -0000
@@ -127,6 +127,7 @@ section entitled ``GNU Free Documentatio
 
 @end titlepage
 @end iftex
+@contents
 @c FIXME: Talk about importance of *order* of args, cmds to linker!
 
 @ifnottex
@@ -6806,6 +6807,4 @@ If you have more than one @code{SECT} st
 % Blame: doc@cygnus.com, 28mar91.
 @end tex
 
-
-@contents
 @bye

Re: Move position of @contents

[Joseph S. Myers]

On Fri, 23 Mar 2007, Richard Sandiford wrote:

> At the moment, the printed versions of most manuals (all except
> libiberty) explicitly put the table of contents at the very end of
> the document, after the index and (where used) the page containing
> typesetting information.  This is at odds with most (although admittedly
> not all) manuals I've seen, and is also at odds with the gcc manual.

The reason this once used to make sense was when makefiles used a sequence 
tex; texindex; tex to generate printed manuals, and contents at the end 
would be more likely to get the page numbers right in some cases.  Since 
nowadays texi2dvi is used and it iterates as many times as needed for page 
numbers to stabilize, putting the contents in their natural position at 
the front is now the right thing to do; I fixed the GCC manuals in 2001.

-- 
Joseph S. Myers
joseph@codesourcery.com

Re: Move position of @contents

[Nick Clifton]

Hi Richard,

> bfd/
> 200x-xx-xx  Richard Sandiford  <richard@codesourcery.com>
> 	    Phil Edwards  <phil@codesourcery.com>
> 
> 	* doc/bfd.texinfo: Put the contents after the title page rather
> 	than at the end of the document.
> 
> binutils/
> 200x-xx-xx  Richard Sandiford  <richard@codesourcery.com>
> 	    Phil Edwards  <phil@codesourcery.com>
> 
> 	* doc/binutils.texi: Put the contents after the title page rather
> 	than at the end of the document.
> 
> gas/
> 200x-xx-xx  Richard Sandiford  <richard@codesourcery.com>
> 	    Phil Edwards  <phil@codesourcery.com>
> 
> 	* doc/as.texinfo: Put the contents after the title page rather
> 	than at the end of the document.
> 
> gprof/
> 200x-xx-xx  Richard Sandiford  <richard@codesourcery.com>
> 	    Phil Edwards  <phil@codesourcery.com>
> 
> 	* gprof.texi: Put the contents after the title page rather
> 	than at the end of the document.
> 
> ld/
> 200x-xx-xx  Richard Sandiford  <richard@codesourcery.com>
> 	    Phil Edwards  <phil@codesourcery.com>
> 
> 	* ld.texinfo: Put the contents after the title page rather
> 	than at the end of the document.

Approved - please apply.

Cheers
   Nick