[patch, fortran, docs] Reorganization of gfortran.texi.

Brooks Moses brooks.moses@codesourcery.com
Sat Dec 16 01:56:00 GMT 2006


:ADDPATCH fortran:

This patch implements the reorganization to gfortran.texi that I 
proposed a couple of weeks ago.  For reference, the revised table of 
contents (with the section numbers from the original version) is as follows:

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

0. Introduction                    (one paragraph intro)

Part I: About GNU Fortran
         1. Getting Started         (what gfortran does, components)
         2. GFortran and GCC        (what GCC is, gfortran is front-end)
         3. GFortran and G77        (why this is not g77v4)
         5. Project Status          (one-paragraph intro)
         5.1 Compiler and Library Status    (what gfortran can do now)
         10. Standards              (a brief list of supported standards)

Part II: Invoking GNU Fortran
         4. GFortran Command Options        (command-line reference)
         6. Runtime Environment Variables   (reference)

Part III: Language Reference
         10.1 F2003 Status          (a list of F2003 features supported)
         7. Extensions              (a collection of reference bits)
         8. Intrinsic Procedures    (a long collection of reference bits)

9. Contributing
         5.2 Proposed Extensions    (a short eclectic list)
GPL, etc. as before
----------------------------------------------------

As noted earlier, this is _only_ a reorganization; there is no new text 
anywhere other than the part headings, and nothing has been removed. 
I'll work on adjustments to those in later patches.

There is one new complication to the patch -- Texinfo currently does not 
include macros to divide documents into parts.  I brought this up on the 
Texinfo mailing list, and the maintainer (Karl Berry) says that it's 
something that's been deep in the to-do list for a while, and he had 
some suggestions for how to go about implementing them.  I'm expecting 
to work this into a proper patch to submit to the upstream Texinfo 
distribution, but that will likely take a while; in the interim, the 
first part of this patch contains a local implementation (based on his 
suggestions) that works reasonably well.

Specifically, the division of the document into parts doesn't affect the 
info side of things at all, other than the (non-linked) changes I've 
made to the top-level @menu.  On the TeX side, it adds a "Part N..." 
line to the tables of contents, and creates a "title page" for each 
part, which is fairly similar to the overall title page in style.

Changelog entry:
-----------------------------------------------------------
2006-12-15  Brooks Moses  <brooks.moses@codesourcery.com>

	* gfortran.texi: Added TeX support for document parts;
	rearranged existing text into "About GNU Fortran",
	"Invoking GNU Fortran", and "Language Reference" parts.

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

Tested with "make info", "make pdf", "make dvi", and, just to be sure I 
haven't messed things up, "cd gcc; make man", on i686-pc-cygwin.

Ok for trunk?  Ok to backport to 4.2, so that it remains easy to 
synchronize later improvements/fixes to the manual?

- Brooks
-------------- next part --------------
A non-text attachment was scrubbed...
Name: texi-reorg.diff
Type: text/x-patch
Size: 17269 bytes
Desc: not available
URL: <http://gcc.gnu.org/pipermail/fortran/attachments/20061216/16df2ce7/attachment.bin>


More information about the Fortran mailing list