help-gnat
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[patch, docs] Standardize GCC manual title pages.


From: Brooks Moses
Subject: [patch, docs] Standardize GCC manual title pages.
Date: Thu, 22 Feb 2007 18:18:09 -0800
User-agent: Thunderbird 1.5.0.9 (Windows/20061207)

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  <address@hidden>

        * 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  <address@hidden>

        * gnat-style.texi: Standardize title page.
        * gnat_rm.texi: Likewise.
        * gnat_ugn.texi: Likewise.

fortran/ChangeLog -----------------------------------------------------
2007-02-21  Brooks Moses  <address@hidden>

        * gfortran.texi: Standardize title page, remove version number
        from copyright page.

treelang/ChangeLog ----------------------------------------------------
2007-02-21  Brooks Moses  <address@hidden>

        * 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
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
address@hidden for GCC version @value{version-GCC}
address@hidden Richard M. Stallman
address@hidden Zachary Weinberg
address@hidden
address@hidden 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
address@hidden Using the GNU Compiler Collection (GCC)
 @titlepage
address@hidden @titlefont{Using the GNU Compiler Collection}
address@hidden 2
address@hidden by Richard M. Stallman and the GCC Developer Community
address@hidden Using the GNU Compiler Collection
address@hidden
address@hidden Richard M. Stallman and the @sc{GCC} Developer Community
 @page
 @vskip 0pt plus 1filll
-For GCC Version @address@hidden
address@hidden 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
address@hidden @finalout
 @title Cpplib Internals
address@hidden for GCC version @value{version-GCC}
address@hidden
 @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
address@hidden GNU Compiler Collection Internals (GCC)
 @titlepage
address@hidden @titlefont{GNU Compiler Collection Internals}
address@hidden 2
address@hidden by Richard M. Stallman and the GCC Developer Community
address@hidden GNU Compiler Collection Internals
address@hidden
address@hidden Richard M. Stallman and the @sc{GCC} Developer Community
 @page
 @vskip 0pt plus 1filll
-For GCC Version @address@hidden
address@hidden 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
+
address@hidden Macro to generate a "For the N.N.N version" subtitle on the title
address@hidden page of TeX documentation.  This macro should be used in the
address@hidden titlepage environment after the title and any other subtitles 
have
address@hidden been placed, and before any authors are placed.
address@hidden versionsubtitle
address@hidden DEVELOPMENT
address@hidden For @sc{gcc} version @value{version-GCC}
address@hidden ifclear
address@hidden DEVELOPMENT
address@hidden For @sc{gcc} version @value{version-GCC} (pre-release)
address@hidden ifset
address@hidden Even if there are no authors, the second titlepage line should be
address@hidden forced to the bottom of the page.
address@hidden 0pt plus 1filll
address@hidden 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
 
address@hidden 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
address@hidden 10
address@hidden The title is printed in a large font.
address@hidden @titlefont{Installing GCC}
address@hidden Installing GCC
address@hidden
 
 @c The following two commands start the copyright page.
 @page
@@ -109,7 +110,7 @@
 @insertcopying
 @end titlepage
 
address@hidden Part 4 Top node and Master Menu
address@hidden 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
 
address@hidden
address@hidden
address@hidden 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
 
address@hidden gcc-common.texi
 
 @dircategory Software development
 @direntry
@@ -39,16 +40,12 @@
 @c %**end of header
 
 @titlepage
address@hidden 10
address@hidden GNAT Coding Style
address@hidden
address@hidden Guide for GNAT Developers}
address@hidden flushright
address@hidden 2
address@hidden Coding Style:}
address@hidden 1
address@hidden @hfill A Guide for GNAT Developers
 @subtitle GNAT, The GNU Ada 95 Compiler
-
address@hidden
 @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
address@hidden GCC version @value{version-GCC}
address@hidden AdaCore
-
address@hidden
address@hidden 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
 @address@hidden@value{PLATFORM}}}
 @end flushright
 @end ifset
-
address@hidden 2
-
 @subtitle GNAT, The GNU Ada 95 Compiler
address@hidden GCC version @value{version-GCC}
-
address@hidden AdaCore
-
address@hidden
address@hidden 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
address@hidden 2
address@hidden The gfortran team
address@hidden
address@hidden The @t{gfortran} team
 @page
 @vskip 0pt plus 1filll
-For the @value{version-GCC} Version
address@hidden 1
 Published by the Free Software address@hidden
 51 Franklin Street, Fifth address@hidden
 Boston, MA 02110-1301, address@hidden
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
address@hidden @titlefont{Using and Maintaining GNU Treelang}
-
address@hidden Using and Maintaining GNU Treelang
 @end ifset
 @end ifset
 @ifclear INTERNALS
@@ -143,12 +142,10 @@
 @ifclear USING
 @title Maintaining GNU Treelang
 @end ifclear
address@hidden 2
address@hidden Tim Josling
address@hidden
address@hidden Tim Josling
 @page
 @vskip 0pt plus 1filll
-For the @value{which-treelang} Version*
address@hidden 1
 Published by the Free Software Foundation @*
 51 Franklin Street, Fifth address@hidden
 Boston, MA 02110-1301, address@hidden

reply via email to

[Prev in Thread] Current Thread [Next in Thread]