[patch, docs] Standardize GCC manual title pages.
Brooks Moses <[email protected]> Thu, 22 Feb 2007 18:18:09 -0800
| Newsgroups | gmane.comp.gcc.patches,gmane.comp.gcc.fortran,gmane.comp.gcc.gnat |
|---|---|
| Message-ID | <[email protected]> |
This is a multi-part message in MIME format. --------------030302020003030706070404 Content-Type: text/plain; charset=ISO-8859-1; format=flowed Content-Transfer-Encoding: 7bit As promised in my recent post to gcc-devel, the attached patch standardizes all of the title pages in the texi documentation under the gcc/ directory. (Note that this patch only changes the pdf and dvi versions; it doesn't affect the info or html.) The new standard is, for simplicity, the standard Texinfo format; I've also put in a "For GCC version N.N.N" subtitle on each of the manuals. In development versions of the compiler, it will say "For GCC version N.N.N (pre-release)", making it easy to distinguish development from release versions of the manuals. I also stuck a table of contents into install.texi while I was standardizing things, since it didn't have one. This, again, is set to only affect the dvi and pdf output. gcc/ChangeLog --------------------------------------------------------- 2007-02-21 Brooks Moses <[email protected]> * doc/include/gcc-common.texi (versionsubtitle): New macro. * doc/cpp.texi: Standardize title page. * doc/cppinternals.texi: Likewise. * doc/gcc.texi: Standardize title page, remove version number from copyright page. * doc/gccint.texi: Likewise. * doc/install.texi: Standardize title page, add table of contents. ada/ChangeLog --------------------------------------------------------- 2007-02-21 Brooks Moses <[email protected]> * gnat-style.texi: Standardize title page. * gnat_rm.texi: Likewise. * gnat_ugn.texi: Likewise. fortran/ChangeLog ----------------------------------------------------- 2007-02-21 Brooks Moses <[email protected]> * gfortran.texi: Standardize title page, remove version number from copyright page. treelang/ChangeLog ---------------------------------------------------- 2007-02-21 Brooks Moses <[email protected]> * treelang.texi: Standardize title page, remove version number from copyright page. ----------------------------------------------------------------------- Tested on i686-pc-linux-gnu with "make pdf" and "make info". Ok for trunk? As a documentation patch, should this also go into 4.2? - Brooks --------------030302020003030706070404 Content-Type: text/x-patch; name="titlepages.diff" Content-Transfer-Encoding: 7bit Content-Disposition: inline; filename="titlepages.diff" Index: gcc/doc/cpp.texi =================================================================== --- gcc/doc/cpp.texi (revision 122137) +++ gcc/doc/cpp.texi (working copy) @@ -58,9 +58,8 @@ @titlepage @title The C Preprocessor -@subtitle for GCC version @value{version-GCC} -@author Richard M. Stallman -@author Zachary Weinberg +@versionsubtitle +@author Richard M. Stallman, Zachary Weinberg @page @c There is a fill at the bottom of the page, so we need a filll to @c override it. Index: gcc/doc/gcc.texi =================================================================== --- gcc/doc/gcc.texi (revision 122137) +++ gcc/doc/gcc.texi (working copy) @@ -73,15 +73,12 @@ @end ifnottex @setchapternewpage odd -@shorttitlepage Using the GNU Compiler Collection (GCC) @titlepage -@center @titlefont{Using the GNU Compiler Collection} -@sp 2 -@center by Richard M. Stallman and the GCC Developer Community +@title Using the GNU Compiler Collection +@versionsubtitle +@author Richard M. Stallman and the @sc{GCC} Developer Community @page @vskip 0pt plus 1filll -For GCC Version @value{version-GCC}@* -@sp 1 Published by: @multitable @columnfractions 0.5 0.5 @item GNU Press Index: gcc/doc/cppinternals.texi =================================================================== --- gcc/doc/cppinternals.texi (revision 122137) +++ gcc/doc/cppinternals.texi (working copy) @@ -41,9 +41,8 @@ @end ifinfo @titlepage -@c @finalout @title Cpplib Internals -@subtitle for GCC version @value{version-GCC} +@versionsubtitle @author Neil Booth @page @vskip 0pt plus 1filll Index: gcc/doc/gccint.texi =================================================================== --- gcc/doc/gccint.texi (revision 122137) +++ gcc/doc/gccint.texi (working copy) @@ -59,15 +59,12 @@ @end ifnottex @setchapternewpage odd -@shorttitlepage GNU Compiler Collection Internals (GCC) @titlepage -@center @titlefont{GNU Compiler Collection Internals} -@sp 2 -@center by Richard M. Stallman and the GCC Developer Community +@title GNU Compiler Collection Internals +@versionsubtitle +@author Richard M. Stallman and the @sc{GCC} Developer Community @page @vskip 0pt plus 1filll -For GCC Version @value{version-GCC}@* -@sp 1 @insertcopying @end titlepage @summarycontents Index: gcc/doc/include/gcc-common.texi =================================================================== --- gcc/doc/include/gcc-common.texi (revision 122137) +++ gcc/doc/include/gcc-common.texi (working copy) @@ -51,3 +51,19 @@ \global\normaloffset =0.75in @end tex @end ifset + +@c Macro to generate a "For the N.N.N version" subtitle on the title +@c page of TeX documentation. This macro should be used in the +@c titlepage environment after the title and any other subtitles have +@c been placed, and before any authors are placed. +@macro versionsubtitle +@ifclear DEVELOPMENT +@subtitle For @sc{gcc} version @value{version-GCC} +@end ifclear +@ifset DEVELOPMENT +@subtitle For @sc{gcc} version @value{version-GCC} (pre-release) +@end ifset +@c Even if there are no authors, the second titlepage line should be +@c forced to the bottom of the page. +@vskip 0pt plus 1filll +@end macro Index: gcc/doc/install.texi =================================================================== --- gcc/doc/install.texi (revision 122137) +++ gcc/doc/install.texi (working copy) @@ -7,6 +7,8 @@ @c %**end of header @c @end ifnothtml +@include gcc-common.texi + @c Specify title for specific html page @ifset indexhtml @settitle Installing GCC @@ -99,9 +101,8 @@ @c Part 3 Titlepage and Copyright @titlepage -@sp 10 -@comment The title is printed in a large font. -@center @titlefont{Installing GCC} +@title Installing GCC +@versionsubtitle @c The following two commands start the copyright page. @page @@ -109,7 +110,7 @@ @insertcopying @end titlepage -@c Part 4 Top node and Master Menu +@c Part 4 Top node, Master Menu, and/or Table of Contents @ifinfo @node Top, , , (dir) @comment node-name, next, Previous, up @@ -129,6 +130,10 @@ @end menu @end ifinfo +@iftex +@contents +@end iftex + @c Part 5 The Body of the Document @c ***Installing GCC********************************************************** @ifnothtml Index: gcc/ada/gnat-style.texi =================================================================== --- gcc/ada/gnat-style.texi (revision 122137) +++ gcc/ada/gnat-style.texi (working copy) @@ -27,6 +27,7 @@ @settitle GNAT Coding Style @setchapternewpage odd +@include gcc-common.texi @dircategory Software development @direntry @@ -39,16 +40,12 @@ @c %**end of header @titlepage -@sp 10 -@title GNAT Coding Style -@flushright -@titlefont{A Guide for GNAT Developers} -@end flushright -@sp 2 +@titlefont{GNAT Coding Style:} +@sp 1 +@title @hfill A Guide for GNAT Developers @subtitle GNAT, The GNU Ada 95 Compiler - +@versionsubtitle @author Ada Core Technologies, Inc. - @page @vskip 0pt plus 1filll Index: gcc/ada/gnat_rm.texi =================================================================== --- gcc/ada/gnat_rm.texi (revision 122137) +++ gcc/ada/gnat_rm.texi (working copy) @@ -43,12 +43,10 @@ @end copying @titlepage - @title GNAT Reference Manual @subtitle GNAT, The GNU Ada 95 Compiler -@subtitle GCC version @value{version-GCC} -@author AdaCore - +@versionsubtitle +@author Ada Core Technologies, Inc. @page @vskip 0pt plus 1filll Index: gcc/ada/gnat_ugn.texi =================================================================== --- gcc/ada/gnat_ugn.texi (revision 122137) +++ gcc/ada/gnat_ugn.texi (working copy) @@ -125,23 +125,16 @@ @end copying @titlepage - @title @value{EDITION} User's Guide - @ifset vms @sp 1 @flushright @titlefont{@i{@value{PLATFORM}}} @end flushright @end ifset - -@sp 2 - @subtitle GNAT, The GNU Ada 95 Compiler -@subtitle GCC version @value{version-GCC} - -@author AdaCore - +@versionsubtitle +@author Ada Core Technologies, Inc. @page @vskip 0pt plus 1filll Index: gcc/fortran/gfortran.texi =================================================================== --- gcc/fortran/gfortran.texi (revision 122238) +++ gcc/fortran/gfortran.texi (working copy) @@ -118,12 +118,10 @@ @setchapternewpage odd @titlepage @title Using GNU Fortran -@sp 2 -@center The gfortran team +@versionsubtitle +@author The @t{gfortran} team @page @vskip 0pt plus 1filll -For the @value{version-GCC} Version -@sp 1 Published by the Free Software Foundation@* 51 Franklin Street, Fifth Floor@* Boston, MA 02110-1301, USA@* Index: gcc/treelang/treelang.texi =================================================================== --- gcc/treelang/treelang.texi (revision 122137) +++ gcc/treelang/treelang.texi (working copy) @@ -133,8 +133,7 @@ @titlepage @ifset INTERNALS @ifset USING -@center @titlefont{Using and Maintaining GNU Treelang} - +@title Using and Maintaining GNU Treelang @end ifset @end ifset @ifclear INTERNALS @@ -143,12 +142,10 @@ @ifclear USING @title Maintaining GNU Treelang @end ifclear -@sp 2 -@center Tim Josling +@versionsubtitle +@author Tim Josling @page @vskip 0pt plus 1filll -For the @value{which-treelang} Version* -@sp 1 Published by the Free Software Foundation @* 51 Franklin Street, Fifth Floor@* Boston, MA 02110-1301, USA@* --------------030302020003030706070404--