Improve g77 doc infrastructure

From-SVN: r25743

gcc/f/ChangeLog

+Sat Mar 13 14:26:55 1999  Craig Burley  <craig@jcb-sc.com>
+
+	* RELEASE-PREP: New file, lists things to do for a release.
+
+	* Make-lang.in, bugs.texi, bugs0.texi, g77.texi, g77install.texi,
+	install0.texi, news.texi, news0.texi: Accommodate new doc
+	architecture.
+	Consolidate news items.  Don't describe old news items in
+	various generated docs.
+	Don't describe FSF-g77 installation stuff in various EGCS-g77
+	generated docs.
+	Move description of AUTOMATIC to more suitable location.
+	* root.texi: New file for new doc architecture.
+
 Thu Mar 11 17:32:55 1999  Craig Burley  <craig@jcb-sc.com>
 
 	* g77.texi: Add AUTOMATIC to list of unsupported extensions.

gcc/f/Make-lang.in

@@ -244,7 +244,7 @@ f77.dvi: f/g77.dvi
 # g77 documentation.
 f/g77.info: $(srcdir)/f/g77.texi $(srcdir)/f/bugs.texi \
 	    $(srcdir)/f/g77install.texi $(srcdir)/f/news.texi \
-	    $(srcdir)/f/intdoc.texi
+	    $(srcdir)/f/intdoc.texi $(srcdir)/f/root.texi
 	case "$(LANGUAGES)" in \
 	  *[fF]77*) touch lang-f77;; \
 	  *) rm -f lang-f77;; \
@@ -256,7 +256,7 @@ f/g77.info: $(srcdir)/f/g77.texi $(srcdir)/f/bugs.texi \
 
 f/g77.dvi: $(srcdir)/f/g77.texi $(srcdir)/f/bugs.texi \
 	    $(srcdir)/f/g77install.texi $(srcdir)/f/news.texi \
-	    $(srcdir)/f/intdoc.texi
+	    $(srcdir)/f/intdoc.texi $(srcdir)/f/root.texi
 	case "$(LANGUAGES)" in \
 	  *[fF]77*) touch lang-f77;; \
 	  *) rm -f lang-f77;; \
@@ -306,15 +306,15 @@ $(srcdir)/f/intdoc.texi: f/intdoc.c f/intdoc.in f/ansify.c f/intrin.def f/intrin
 	  rm f/intdoc f/ansify f/intdoc.h0; \
 	else true; fi
 
-$(srcdir)/f/BUGS: f/bugs0.texi f/bugs.texi
+$(srcdir)/f/BUGS: f/bugs0.texi f/bugs.texi f/root.texi
 	cd $(srcdir)/f; $(MAKEINFO) -D BUGSONLY --no-header --no-split \
 	  --no-validate -o BUGS bugs0.texi
 
-$(srcdir)/f/INSTALL: f/install0.texi f/g77install.texi
+$(srcdir)/f/INSTALL: f/install0.texi f/g77install.texi f/root.texi
 	cd $(srcdir)/f; $(MAKEINFO) -D INSTALLONLY --no-header --no-split \
 	  --no-validate -o INSTALL install0.texi
 
-$(srcdir)/f/NEWS: f/news0.texi f/news.texi
+$(srcdir)/f/NEWS: f/news0.texi f/news.texi f/root.texi
 	cd $(srcdir)/f; $(MAKEINFO) -D NEWSONLY --no-header --no-split \
 	  --no-validate -o NEWS news0.texi
 

gcc/f/RELEASE-PREP

+1999-03-13  RELEASE-PREP
+
+Things to do to prepare a g77 release (FSF, egcs, whatever).
+
+-  Update root.texi: clear DEVELOPMENT flag, set version info.

gcc/f/bugs.texi

-@c Copyright (C) 1995-1998 Free Software Foundation, Inc.
+@c Copyright (C) 1995-1999 Free Software Foundation, Inc.
 @c This is part of the G77 manual.
 @c For copying conditions, see the file g77.texi.
 
-@c When changing the above copyright notice, be sure to
-@c change the one in `bugs0.texi' accordingly, to effect
-@c the change in the derived file `BUGS'.
-
 @c The text of this file appears in the file BUGS
 @c in the G77 distribution, as well as in the G77 manual.
 
-@c 1999-03-03
+@c Keep this the same as the dates above, since it's used
+@c in the standalone derivations of this file (e.g. BUGS).
+@set copyrights-bugs 1995-1999
+
+@set last-update-bugs 1999-03-13
+
+@include root.texi
+
+@ifset DOC-BUGS
+@c The immediately following lines apply to the BUGS file
+@c which is derived from this file.
+@emph{Note:} This file is automatically generated from the files
+@file{bugs0.texi} and @file{bugs.texi}.
+@file{BUGS} is @emph{not} a source file,
+although it is normally included within source distributions.
+
+This file lists known bugs in the @value{which-g77} version
+of the GNU Fortran compiler.
+Copyright (C) @value{copyrights-bugs} Free Software Foundation, Inc.
+You may copy, distribute, and modify it freely as long as you preserve
+this copyright notice and permission notice.
+
+@node Top,,, (dir)
+@chapter Known Bugs In GNU Fortran
+@end ifset
 
-@ifclear BUGSONLY
-@node Actual Bugs
-@section Actual Bugs We Haven't Fixed Yet
-@end ifclear
+@ifset DOC-G77
+@node Known Bugs
+@section Known Bugs In GNU Fortran
+@end ifset
 
 This section identifies bugs that @code{g77} @emph{users}
-might run into in
-@ifhtml
-the current development
-@end ifhtml
-version
-@ifnothtml
-@value{version-g77}
-@end ifnothtml
+might run into in the @value{which-g77} version
 of @code{g77}.
 This includes bugs that are actually in the @code{gcc}
 back end (GBE) or in @code{libf2c}, because those
@@ -32,22 +45,56 @@ sets of code are at least somewhat under the control
 of (and necessarily intertwined with) @code{g77},
 so it isn't worth separating them out.
 
+@ifset DOC-G77
 For information on bugs in @emph{other} versions of @code{g77},
-@ifhtml
-see the page on Fortran news.
-@end ifhtml
-@ifnothtml
 @ref{News,,News About GNU Fortran}.
-@end ifnothtml
+There, lists of bugs fixed in various versions of @code{g77},
+can help determine what bugs existed in prior versions.
+@end ifset
 
+@ifset DOC-BUGS
+For information on bugs in @emph{other} versions of @code{g77},
+see @file{@value{path-g77}/NEWS}.
+There, lists of bugs fixed in various versions of @code{g77},
+can help determine what bugs existed in prior versions.
+@end ifset
+
+@ifset DEVELOPMENT
+@emph{Warning:} The information below is still under development,
+and might not accurately reflect the @code{g77} code base
+of which it is a part.
+Efforts are made to keep it somewhat up-to-date,
+but they are particularly concentrated
+on any version of this information
+that is distributed as part of a @emph{released} @code{g77}.
+
+In particular, while this information is intended to apply to
+the @value{which-g77} version of @code{g77},
+only an official @emph{release} of that version
+is expected to contain documentation that is
+most consistent with the @code{g77} product in that version.
+@end ifset
+
+An online, ``live'' version of this document
+(derived directly from the mainline, development version
+of @code{g77} within @code{egcs})
+is available via
+@uref{http://egcs.cygnus.com/onlinedocs/g77_bugs.html}.
+Follow the ``Known Bugs'' link.
+
+@ifset DOC-G77
 For information on bugs that might afflict people who
 configure, port, build, and install @code{g77},
-@ifhtml
-see the chapter on installing in the @code{g77} documentation.
-@end ifhtml
-@ifnothtml
 @ref{Problems Installing}.
-@end ifnothtml
+@end ifset
+
+@ifset DOC-BUGS
+For information on bugs that might afflict people who
+configure, port, build, and install @code{g77},
+see "Problems Installing" in @file{@value{path-g77}/INSTALL}.
+@end ifset
+
+The following information was last updated on @value{last-update-bugs}:
 
 @itemize @bullet
 @item
@@ -129,14 +176,11 @@ improvements to the compiler.)
 
 Note that @code{g77} does display a warning message to
 notify the user before the compiler appears to hang.
-@ifhtml
-See the @code{g77} installation documentation
-@end ifhtml
-@ifnothtml
+@ifset DOC-G77
 @xref{Large Initialization,,Initialization of Large Aggregate Areas},
-@end ifnothtml
 for information on how to change the point at which
 @code{g77} decides to issue this warning.
+@end ifset
 
 @cindex debugging
 @cindex common blocks
@@ -154,13 +198,10 @@ As of Version 0.5.19, a temporary kludge solution is provided whereby
 some rudimentary information on a member is written as a string that
 is the member's value as a character string.
 
-@ifhtml
-See the @code{g77} documentation
-@end ifhtml
-@ifnothtml
+@ifset DOC-G77
 @xref{Code Gen Options,,Options for Code Generation Conventions},
-@end ifnothtml
 for information on the @samp{-fdebug-kludge} option.
+@end ifset
 
 @cindex code, displaying main source
 @cindex displaying main source code

gcc/f/bugs0.texi

 \input texinfo  @c -*-texinfo-*-
-@c %**start of header 
+@c %**start of header
 @setfilename BUGS
-@set BUGSONLY
 @c %**end of header
 
-@c The immediately following lines apply to the BUGS file
-@c which is generated using this file.
-NOTE: This file is automatically generated from the files
-`bugs0.texi' and `bugs.texi'.  `BUGS' is *not* a source file,
-although it is normally included within source distributions.
-
-This file lists known bugs in the GNU Fortran compiler.
-Copyright (C) 1995-1998 Free Software Foundation, Inc.
-You may copy, distribute, and modify it freely as long as you preserve
-this copyright notice and permission notice.
-
-@node Top,,, (dir)
-@chapter Bugs in GNU Fortran
+@c This tells bugs.texi that it's generating just the BUGS file.
+@set DOC-BUGS
 @include bugs.texi
 @bye

gcc/f/install0.texi

 \input texinfo  @c -*-texinfo-*-
 @c %**start of header 
 @setfilename INSTALL
-@set INSTALLONLY
 @c %**end of header
 
-@c The immediately following lines apply to the INSTALL file
-@c which is generated using this file.
-NOTE: This file is automatically generated from the files
-`install0.texi' and `g77install.texi'.  `INSTALL' is *not* a source
-file, although it is normally included within source distributions.
-
-This file contains installation information for the GNU Fortran compiler.
-Copyright (C) 1995-1998 Free Software Foundation, Inc.
-You may copy, distribute, and modify it freely as long as you preserve
-this copyright notice and permission notice.
-
-@node Top,,, (dir)
-@chapter Installing GNU Fortran
+@c This tells g77install.texi that it's generating just the INSTALL file.
+@set DOC-INSTALL
 @include g77install.texi
 @bye

gcc/f/news0.texi

 \input texinfo  @c -*-texinfo-*-
-@c %**start of header 
-@setfilename NEW
-@set NEWSONLY
+@c %**start of header
+@setfilename NEWS
 @c %**end of header
 
-@c The immediately following lines apply to the NEWS file
-@c which is generated using this file.
-NOTE: This file is automatically generated from the files
-`news0.texi' and `news.texi'.  `NEWS' is *not* a source file,
-although it is normally included within source distributions.
-
-This file lists recent changes to the GNU Fortran compiler.
-Copyright (C) 1995-1999 Free Software Foundation, Inc.
-You may copy, distribute, and modify it freely as long as you preserve
-this copyright notice and permission notice.
-
-@node Top,,, (dir)
-@chapter News About GNU Fortran
+@c This tells news.texi that it's generating just the NEWS file.
+@set DOC-NEWS
 @include news.texi
 @bye

gcc/f/root.texi

+@c DEVELOPMENT is set to indicate an in-development version,
+@c as compared to a release version.  When making a release
+@c (e.g. a release branch in the CVS repository for egcs),
+@c clear this and set the version information correctly.
+@set DEVELOPMENT
+@set version-g77 0.5.24
+@set version-egcs 1.2
+
+@c EGCS-G77 is set to indicate this is the EGCS version of g77.
+@set EGCS-G77
+
+@ifclear EGCS-G77
+@c FSF-G77 is set to indicate this is the FSF version of g77.
+@set FSF-G77
+@end ifclear
+
+@ifset EGCS-G77
+@set email-general egcs@@egcs.cygnus.com
+@set email-bugs egcs-bugs@@egcs.cygnus.com
+@set path-g77 egcs/gcc/f
+@set path-libf2c egcs/libf2c
+@set which-g77 EGCS-@value{version-egcs}
+@end ifset
+
+@ifset FSF-G77
+@set email-general fortran@@gnu.org
+@set email-bugs fortran@@gnu.org
+@set path-g77 gcc/f
+@set path-libf2c gcc/f/runtime
+@set which-g77 FSF-@value{version-g77}
+@end ifset
+
+@set email-burley craig@@jcb-sc.com