This is the mail archive of the gcc-patches@gcc.gnu.org mailing list for the GCC project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

[patch, fortran, docs, committed] Lower "Part I: Introduction" to a chapter


--------------------------------------------------------------
2007-01-03  Brooks Moses  <brooks.moses@codesourcery.com>

	* gfortran.texi (Introduction): Lower "Part I:
	Introduction" to a chapter, renumber Parts II and III to
	Parts I and II.
	* intrinsic.texi (Introduction): Rename to "Introduction
	to Intrinsics" to avoid conflict with the new chapter.

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

The "Introduction" part of the manual from the previous reorganization is a collection of relatively short pieces, which should probably be rewritten to be even shorter. It's a waste of space to have each of these little pieces in a chapter of their own; thus, this patch lowers the "Introduction" part to a chapter, and lowers the chapters that make it up into sections.

Thus, the structure of the manual is now a standalone "Introduction" chapter, two large parts consisting of invokation and language references, and then standalone chapters consisting of the GNU boilerplate at the end.

Tested with "make pdf" and "make info"; committed to trunk under blanket
approval from Steve Kargl.

- Brooks
Index: gfortran.texi
===================================================================
--- gfortran.texi	(revision 120424)
+++ gfortran.texi	(working copy)
@@ -151,6 +151,11 @@
 
 @page
 
+@c ---------------------------------------------------------------------
+@c TexInfo table of contents.
+@c ---------------------------------------------------------------------
+
+@ifnottex
 @node Top
 @top Introduction
 @cindex Introduction
@@ -171,18 +176,13 @@
 @comment  better formatting.
 @comment
 @menu
-Part I: About GNU Fortran
-* Getting Started::      What you should know about GNU Fortran.
-* GNU Fortran and GCC::  You can compile Fortran, C, or other programs.
-* GNU Fortran and G77::  Why we chose to start from scratch.
-* Project Status::       Status of GNU Fortran, roadmap, proposed extensions.
-* Standards::	         Standards supported by GNU Fortran.
+* Introduction::
 
-Part II: Invoking GNU Fortran
+Part I: Invoking GNU Fortran
 * Invoking GNU Fortran:: Command options supported by @command{gfortran}.
 * Runtime::              Influencing runtime behavior with environment variables.
 
-Part III: Language Reference
+Part II: Language Reference
 * Fortran 2003 status::  Fortran 2003 features supported by GNU Fortran.
 * Extensions::           Language extensions implemented by GNU Fortran.
 * Intrinsic Procedures:: Intrinsic procedures supported by GNU Fortran.
@@ -195,28 +195,50 @@
 * Funding::              How to help assure continued work for free software.
 * Index::                Index of this documentation.
 @end menu
+@end ifnottex
 
+@c ---------------------------------------------------------------------
+@c Introduction
+@c ---------------------------------------------------------------------
 
-@c =====================================================================
-@c PART I: ABOUT GNU FORTRAN
-@c =====================================================================
+@node Introduction
+@chapter Introduction
 
-@tex
-\part{I}{About GNU Fortran}
-@end tex
+@c The following duplicates the text on the TexInfo table of contents.
+@iftex
+This manual documents the use of @command{gfortran}, the GNU Fortran
+compiler. You can find in this manual how to invoke @command{gfortran},
+as well as its features and incompatibilities.
 
-@c ---------------------------------------------------------------------
-@c Getting Started
-@c ---------------------------------------------------------------------
+@ifset DEVELOPMENT
+@emph{Warning:} This document, and the compiler it describes, are still
+under development.  While efforts are made to keep it up-to-date, it
+might not accurately reflect the status of the most recent GNU Fortran
+compiler.
+@end ifset
+@end iftex
 
-@node Getting Started
-@chapter Getting Started
-
 The GNU Fortran compiler front end was
 designed initially as a free replacement for,
 or alternative to, the unix @command{f95} command;
 @command{gfortran} is the command you'll use to invoke the compiler.
 
+@menu
+* About GNU Fortran::    What you should know about the GNU Fortran compiler.
+* GNU Fortran and GCC::  You can compile Fortran, C, or other programs.
+* GNU Fortran and G77::  Why we chose to start from scratch.
+* Project Status::       Status of GNU Fortran, roadmap, proposed extensions.
+* Standards::	         Standards supported by GNU Fortran.
+@end menu
+
+
+@c ---------------------------------------------------------------------
+@c About GNU Fortran
+@c ---------------------------------------------------------------------
+
+@node About GNU Fortran
+@section About GNU Fortran
+
 The GNU Fortran compiler is still in an early state of development.
 It can generate code for most constructs and expressions,
 but much work remains to be done.
@@ -327,7 +349,7 @@
 @c ---------------------------------------------------------------------
 
 @node GNU Fortran and GCC
-@chapter GNU Fortran and GCC
+@section GNU Fortran and GCC
 @cindex GNU Compiler Collection
 
 GCC used to be the GNU ``C'' Compiler,
@@ -379,7 +401,7 @@
 @c ---------------------------------------------------------------------
 
 @node GNU Fortran and G77
-@chapter GNU Fortran and G77
+@section GNU Fortran and G77
 @cindex Fortran 77
 @cindex G77
 
@@ -420,7 +442,7 @@
 @c ---------------------------------------------------------------------
 
 @node Project Status
-@chapter Project Status
+@section Project Status
 
 @quotation
 As soon as @command{gfortran} can parse all of the statements correctly,
@@ -480,7 +502,7 @@
 @c ---------------------------------------------------------------------
 
 @node Standards
-@chapter Standards
+@section Standards
 @cindex Standards
 
 The GNU Fortran compiler implements
@@ -496,11 +518,11 @@
 
 
 @c =====================================================================
-@c PART II: INVOCATION REFERENCE
+@c PART I: INVOCATION REFERENCE
 @c =====================================================================
 
 @tex
-\part{II}{Invoking GNU Fortran}
+\part{I}{Invoking GNU Fortran}
 @end tex
 
 @c ---------------------------------------------------------------------
@@ -687,11 +709,11 @@
 
 
 @c =====================================================================
-@c PART III: LANGUAGE REFERENCE
+@c PART II: LANGUAGE REFERENCE
 @c =====================================================================
 
 @tex
-\part{III}{Language Reference}
+\part{II}{Language Reference}
 @end tex
 
 @c ---------------------------------------------------------------------
Index: intrinsic.texi
===================================================================
--- intrinsic.texi	(revision 120426)
+++ intrinsic.texi	(working copy)
@@ -49,7 +49,7 @@
 @comment  - Short
 
 @menu
-* Introduction:         Introduction
+* Introduction:         Introduction to Intrinsics
 * @code{ABORT}:         ABORT,     Abort the program     
 * @code{ABS}:           ABS,       Absolute value     
 * @code{ACCESS}:        ACCESS,    Checks file access modes
@@ -251,7 +251,7 @@
 * @code{XOR}:           XOR,       Bitwise logical exclusive or
 @end menu
 
-@node Introduction
+@node Introduction to Intrinsics
 @section Introduction to intrinsic procedures
 
 The intrinsic procedures provided by GNU Fortran include all of the

Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]