Standardize GCC manual title pages.

[Brooks Moses-3]

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  <brooks.moses@...>

        * 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  <brooks.moses@...>

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

fortran/ChangeLog -----------------------------------------------------
2007-02-21  Brooks Moses  <brooks.moses@...>

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

treelang/ChangeLog ----------------------------------------------------
2007-02-21  Brooks Moses  <brooks.moses@...>

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

_______________________________________________
help-gnat mailing list
help-gnat@...
http://lists.gnu.org/mailman/listinfo/help-gnat

[Steve Kargl]

On Thu, Feb 22, 2007 at 06:18:09PM -0800, Brooks Moses wrote:
>
> fortran/ChangeLog -----------------------------------------------------
> 2007-02-21  Brooks Moses  <brooks.moses@...>
>
> * gfortran.texi: Standardize title page, remove version number
> from copyright page.
>

These bits are OK.

--
Steve


_______________________________________________
help-gnat mailing list
help-gnat@...
http://lists.gnu.org/mailman/listinfo/help-gnat

[Gerald Pfeifer]

On Thu, 22 Feb 2007, Brooks Moses wrote:
> Tested on i686-pc-linux-gnu with "make pdf" and "make info".  Ok for trunk?

>From what I can see, this is fine (and certainly welcome), thanks!

For a change of this kind, I'd prefer Joseph to have a look as well,
so please give him a bit of time before checking this in.

(Joseph, http://gcc.gnu.org/ml/gcc-patches/2007-02/msg01863.html has
the original patch.)

> As a documentation patch, should this also go into 4.2?

Yes, please!

Gerald


_______________________________________________
help-gnat mailing list
help-gnat@...
http://lists.gnu.org/mailman/listinfo/help-gnat

[Joseph S. Myers]

On Sun, 25 Feb 2007, Gerald Pfeifer wrote:

> For a change of this kind, I'd prefer Joseph to have a look as well,
> so please give him a bit of time before checking this in.
>
> (Joseph, http://gcc.gnu.org/ml/gcc-patches/2007-02/msg01863.html has
> the original patch.)

This is OK with me.  (While GNU Press considerations might influence title
page layout, I think we should ignore such considerations for now unless
and until they start working with the community to discuss their changes
on gcc-patches and merge them as individual logical fixes rather than
producing local forks and leaving merging megapatches to others.)

--
Joseph S. Myers
joseph@...


_______________________________________________
help-gnat mailing list
help-gnat@...
http://lists.gnu.org/mailman/listinfo/help-gnat

[Brooks Moses-3]

Joseph S. Myers wrote:

> On Sun, 25 Feb 2007, Gerald Pfeifer wrote:
>> For a change of this kind, I'd prefer Joseph to have a look as well,
>> so please give him a bit of time before checking this in.
>>
>> (Joseph, http://gcc.gnu.org/ml/gcc-patches/2007-02/msg01863.html has
>> the original patch.)
>
> This is OK with me.  (While GNU Press considerations might influence title
> page layout, I think we should ignore such considerations for now unless
> and until they start working with the community to discuss their changes
> on gcc-patches and merge them as individual logical fixes rather than
> producing local forks and leaving merging megapatches to others.)

Committed to trunk, and to 4.2 after testing on i686-pc-linux-gnu.

In theory -- and I think in practice, even -- if someone wants to alter
the title page layout, the easiest way to do that is now to redefine the
@titlepage commands with some code in gcc-common.texi, rather than
hardwiring it in the individual manuals, and they'll get the same
results everywhere.

(Well, no, in practice they'll forget to test it on Ada and it will
break the one Ada manual that has a two-line title.  But the theory is
sound.)

- Brooks



_______________________________________________
help-gnat mailing list
help-gnat@...
http://lists.gnu.org/mailman/listinfo/help-gnat

[Andreas Schwab]

Brooks Moses <brooks.moses@...> writes:

> Joseph S. Myers wrote:
>> On Sun, 25 Feb 2007, Gerald Pfeifer wrote:
>>> For a change of this kind, I'd prefer Joseph to have a look as well,
>>> so please give him a bit of time before checking this in.
>>>
>>> (Joseph, http://gcc.gnu.org/ml/gcc-patches/2007-02/msg01863.html has
>>> the original patch.)
>>
>> This is OK with me.  (While GNU Press considerations might influence
>> title page layout, I think we should ignore such considerations for now
>> unless and until they start working with the community to discuss their
>> changes on gcc-patches and merge them as individual logical fixes rather
>> than producing local forks and leaving merging megapatches to others.)
>
> Committed to trunk, and to 4.2 after testing on i686-pc-linux-gnu.

I'm getting this on the 4.2 branch:

(echo "@set version-GCC 4.2.0"; \
 if [ "prerelease" = "experimental" ]; \
 then echo "@set DEVELOPMENT"; \
 else echo "@clear DEVELOPMENT"; \
 fi) > gcc-vers.texiT
echo "@set srcdir ../../gcc" >> gcc-vers.texiT
if [ xinfo = xinfo ]; then \
        makeinfo --split-size=5000000 --split-size=5000000 --split-size=5000000 --no-split -I ../../gcc/doc \
                -I ../../gcc/doc/include -o doc/gccinstall.info ../../gcc/doc/install.texi; \
fi
mv -f gcc-vers.texiT gcc-vers.texi
../../gcc/doc/include/gcc-common.texi:11: @include `gcc-vers.texi': No such file or directory.
makeinfo: Removing output file `doc/gccinstall.info' due to errors; use --force to preserve.
make[3]: *** [doc/gccinstall.info] Error 1

Andreas.

--
Andreas Schwab, SuSE Labs, schwab@...
SuSE Linux Products GmbH, Maxfeldstraße 5, 90409 Nürnberg, Germany
PGP key fingerprint = 58CA 54C7 6D53 942B 1756  01D3 44D5 214B 8276 4ED5
"And now for something completely different."


_______________________________________________
help-gnat mailing list
help-gnat@...
http://lists.gnu.org/mailman/listinfo/help-gnat

[Brooks Moses-3]

Andreas Schwab wrote:

> Brooks Moses <brooks.moses@...> writes:
>> Committed to trunk, and to 4.2 after testing on i686-pc-linux-gnu.
>
> I'm getting this on the 4.2 branch:
>
> (echo "@set version-GCC 4.2.0"; \
>  if [ "prerelease" = "experimental" ]; \
>  then echo "@set DEVELOPMENT"; \
>  else echo "@clear DEVELOPMENT"; \
>  fi) > gcc-vers.texiT
> echo "@set srcdir ../../gcc" >> gcc-vers.texiT
> if [ xinfo = xinfo ]; then \
>         makeinfo --split-size=5000000 --split-size=5000000 --split-size=5000000 --no-split -I ../../gcc/doc \
>                 -I ../../gcc/doc/include -o doc/gccinstall.info ../../gcc/doc/install.texi; \
> fi
> mv -f gcc-vers.texiT gcc-vers.texi
> ../../gcc/doc/include/gcc-common.texi:11: @include `gcc-vers.texi': No such file or directory.
> makeinfo: Removing output file `doc/gccinstall.info' due to errors; use --force to preserve.
> make[3]: *** [doc/gccinstall.info] Error 1

Bleah.  It works fine on my system, but apparently that's just luck -- I
missed including the new gcc-vers.texi dependency in gccinstall.* in the
Makefile, but on my system the "mv -f gcc-vers.texiT gcc-vers.texi" line
happens to get executed first anyway.

The attached patch ought to fix it; I've tested it on i686-pc-linux-gnu
(which unfortunately doesn't prove it fixes anything, because it worked
before, but at least proves it didn't break things), and committed it to
4.2 and trunk as obvious.  (svn 122365 and 122366)  Let me know if this
doesn't fix things.

Apologies for the breakage.

- Brooks


-----------------------------------------------------------------------
2007-02-26  Brooks Moses  <brooks.moses@...>

        * Makefile.in (TEXI_GCCINSTALL_FILES): Add gcc-vers.texi
        dependency.

-----------------------------------------------------------------------


Index: gcc/Makefile.in
===================================================================
--- gcc/Makefile.in (revision 122357)
+++ gcc/Makefile.in (working copy)
@@ -3530,7 +3530,8 @@
  sourcebuild.texi gty.texi libgcc.texi cfg.texi tree-ssa.texi \
  loop.texi
 
-TEXI_GCCINSTALL_FILES = install.texi install-old.texi fdl.texi
+TEXI_GCCINSTALL_FILES = install.texi install-old.texi fdl.texi \
+ gcc-vers.texi
 
 TEXI_CPPINT_FILES = cppinternals.texi gcc-common.texi gcc-vers.texi
 

_______________________________________________
help-gnat mailing list
help-gnat@...
http://lists.gnu.org/mailman/listinfo/help-gnat

[Andreas Schwab]

Brooks Moses <brooks.moses@...> writes:

> -----------------------------------------------------------------------
> 2007-02-26  Brooks Moses  <brooks.moses@...>
>
> * Makefile.in (TEXI_GCCINSTALL_FILES): Add gcc-vers.texi
> dependency.

gcc-common.texi is also missing.  Installed as obvious.

Andreas.

2007-02-27  Andreas Schwab  <schwab@...>

        * Makefile.in (TEXI_GCCINSTALL_FILES): Add gcc-common.texi.

Index: gcc/Makefile.in
===================================================================
--- Makefile.in (revision 122367)
+++ Makefile.in (working copy)
@@ -3531,7 +3531,7 @@ TEXI_GCCINT_FILES = gccint.texi gcc-comm
  loop.texi
 
 TEXI_GCCINSTALL_FILES = install.texi install-old.texi fdl.texi \
- gcc-vers.texi
+ gcc-common.texi gcc-vers.texi
 
 TEXI_CPPINT_FILES = cppinternals.texi gcc-common.texi gcc-vers.texi
 

--
Andreas Schwab, SuSE Labs, schwab@...
SuSE Linux Products GmbH, Maxfeldstraße 5, 90409 Nürnberg, Germany
PGP key fingerprint = 58CA 54C7 6D53 942B 1756  01D3 44D5 214B 8276 4ED5
"And now for something completely different."


_______________________________________________
help-gnat mailing list
help-gnat@...
http://lists.gnu.org/mailman/listinfo/help-gnat

[Brooks Moses-3]

At 02:47 AM 2/27/2007, Andreas Schwab wrote:
>Brooks Moses <brooks.moses@...> writes:
> > -----------------------------------------------------------------------
> > 2007-02-26  Brooks Moses  <brooks.moses@...>
> >
> >       * Makefile.in (TEXI_GCCINSTALL_FILES): Add gcc-vers.texi
> >       dependency.
>
>gcc-common.texi is also missing.  Installed as obvious.

Sigh; that's what I get for fixing these things in the wee hours of the
morning.  Thanks for correcting that for me!

- Brooks



_______________________________________________
help-gnat mailing list
help-gnat@...
http://lists.gnu.org/mailman/listinfo/help-gnat

[Andreas Schwab]

Andreas Schwab <schwab@...> writes:

> Brooks Moses <brooks.moses@...> writes:
>
>> -----------------------------------------------------------------------
>> 2007-02-26  Brooks Moses  <brooks.moses@...>
>>
>> * Makefile.in (TEXI_GCCINSTALL_FILES): Add gcc-vers.texi
>> dependency.
>
> gcc-common.texi is also missing.  Installed as obvious.

More fallout from this.

Andreas.

2007-02-28  Andreas Schwab  <schwab@...>

        * Make-lang.in (doc/gnat_ugn_unw.texi): Depend on
        $(gcc_docdir)/include/gcc-common.texi and gcc-vers.texi.
        (doc/gnat-style.info): Likewise.

Index: gcc/ada/Make-lang.in
===================================================================
--- gcc/ada/Make-lang.in (revision 122401)
+++ gcc/ada/Make-lang.in (working copy)
@@ -1,6 +1,6 @@
 # Top level -*- makefile -*- fragment for GNU Ada (GNAT).
 #   Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002,
-#   2003, 2004, 2005, 2006 Free Software Foundation, Inc.
+#   2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
 
 #This file is part of GCC.
 
@@ -388,7 +388,8 @@ ada/doctools/xgnatugn$(build_exeext): ad
 # Note that gnat_ugn_unw.texi does not depend on xgnatugn
 # being built so we can distribute a pregenerated gnat_ugn_unw.info
 
-doc/gnat_ugn_unw.texi: $(srcdir)/ada/gnat_ugn.texi $(srcdir)/ada/ug_words
+doc/gnat_ugn_unw.texi: $(srcdir)/ada/gnat_ugn.texi $(srcdir)/ada/ug_words \
+   $(gcc_docdir)/include/gcc-common.texi gcc-vers.texi
  $(MAKE) ada/doctools/xgnatugn$(build_exeext)
  ada/doctools/xgnatugn unw $(srcdir)/ada/gnat_ugn.texi \
    $(srcdir)/ada/ug_words doc/gnat_ugn_unw.texi
@@ -396,7 +397,6 @@ doc/gnat_ugn_unw.texi: $(srcdir)/ada/gna
 doc/gnat_ugn_unw.info: doc/gnat_ugn_unw.texi \
    $(gcc_docdir)/include/fdl.texi $(gcc_docdir)/include/gcc-common.texi \
    gcc-vers.texi
-
  if [ x$(BUILD_INFO) = xinfo ]; then \
   rm -f $(@)*; \
   $(MAKEINFO) $(MAKEINFOFLAGS) -I$(gcc_docdir)/include \
@@ -411,7 +411,8 @@ doc/gnat_rm.info: ada/gnat_rm.texi $(gcc
             -I$(srcdir)/ada -o $@ $<; \
  else true; fi
 
-doc/gnat-style.info: ada/gnat-style.texi $(gcc_docdir)/include/fdl.texi
+doc/gnat-style.info: ada/gnat-style.texi $(gcc_docdir)/include/fdl.texi \
+   $(gcc_docdir)/include/gcc-common.texi gcc-vers.texi
  if [ x$(BUILD_INFO) = xinfo ]; then \
   rm -f $(@)*; \
   $(MAKEINFO) $(MAKEINFOFLAGS) -I$(gcc_docdir)/include \

--
Andreas Schwab, SuSE Labs, schwab@...
SuSE Linux Products GmbH, Maxfeldstraße 5, 90409 Nürnberg, Germany
PGP key fingerprint = 58CA 54C7 6D53 942B 1756  01D3 44D5 214B 8276 4ED5
"And now for something completely different."


_______________________________________________
help-gnat mailing list
help-gnat@...
http://lists.gnu.org/mailman/listinfo/help-gnat