diff options
| author | Ralf Wildenhues <Ralf.Wildenhues@gmx.de> | 2010-09-22 20:22:51 +0000 |
|---|---|---|
| committer | Ralf Wildenhues <rwild@gcc.gnu.org> | 2010-09-22 20:22:51 +0000 |
| commit | ab940b73bfabe2cec4a26887f959c868388f5117 (patch) | |
| tree | 2adfb70df9f3f8a0a39ba59bde6a9fda1e0c5b13 /gcc/fortran | |
| parent | 60cf253a8b1ebaabf6dd476a1177a24ab7f6d48c (diff) | |
| download | gcc-ab940b73bfabe2cec4a26887f959c868388f5117.zip gcc-ab940b73bfabe2cec4a26887f959c868388f5117.tar.gz gcc-ab940b73bfabe2cec4a26887f959c868388f5117.tar.bz2 | |
Improve formatting of manuals.
contrib/:
* texi2pod.pl: Replace @@ before @{ and @}, for @samp{@@}.
Also escape characters with grave accents, to be fixed ...
(unmunge): ... here.
(postprocess): Also handle @/ and @acronym{...}.
gcc/:
* doc/contrib.texi (Contributors): Allow URL to wrap in PDF
output.
* doc/cppopts.texi: Fix markup of index entry.
* doc/extend.texi (Constructing Calls): Fix markup of
__builtin_va_arg_pack and __builtin_va_arg_pack_len definition.
(Conditionals, C++ Comments, Pragmas, Unnamed Fields, Thread-Local)
(Vague Linkage, C++ Attributes): Fix markup of index entries and
keywords.
* doc/invoke.texi (Option Summary): Fix spacing. Rewrap to
avoid long lines.
(C Dialect Options, C++ Dialect Options, Warning Options)
(Debugging Options, Spec Files, Darwin Options)
(i386 and x86-64 Options, MIPS Options)
(RS/6000 and PowerPC Options, Code Gen Options): Fix markup of
index entries, avoid abbreviations, allow URLs to wrap, avoid
long lines, avoid overlong pages from long @itemx lists.
* doc/objc.texi (Garbage Collection): Allow URLs to wrap.
* doc/standards.texi (Standards): Likewise.
* doc/trouble.texi (Incompatibilities): Fix markup of index
entry.
gcc/fortran/:
* gfortran.texi (Argument list functions): Allow URL to wrap.
* intrinsic.texi (GETGID, GETPID, GETUID, IMAGE_INDEX)
(IS_IOSTAT_END, IS_IOSTAT_EOR, NUM_IMAGES, THIS_IMAGE)
(ISO_FORTRAN_ENV): Fix markup in index entries, and a couple of
code markups in the text.
* invoke.texi (Fortran Dialect Options)
(Error and Warning Options, Directory Options, Code Gen Options):
Likewise. Remove @code inside @smallexample.
From-SVN: r164533
Diffstat (limited to 'gcc/fortran')
| -rw-r--r-- | gcc/fortran/ChangeLog | 11 | ||||
| -rw-r--r-- | gcc/fortran/gfortran.texi | 2 | ||||
| -rw-r--r-- | gcc/fortran/intrinsic.texi | 28 | ||||
| -rw-r--r-- | gcc/fortran/invoke.texi | 44 |
4 files changed, 48 insertions, 37 deletions
diff --git a/gcc/fortran/ChangeLog b/gcc/fortran/ChangeLog index b9df02f..8fbff60d 100644 --- a/gcc/fortran/ChangeLog +++ b/gcc/fortran/ChangeLog @@ -1,3 +1,14 @@ +2010-08-22 Ralf Wildenhues <Ralf.Wildenhues@gmx.de> + + * gfortran.texi (Argument list functions): Allow URL to wrap. + * intrinsic.texi (GETGID, GETPID, GETUID, IMAGE_INDEX) + (IS_IOSTAT_END, IS_IOSTAT_EOR, NUM_IMAGES, THIS_IMAGE) + (ISO_FORTRAN_ENV): Fix markup in index entries, and a couple of + code markups in the text. + * invoke.texi (Fortran Dialect Options) + (Error and Warning Options, Directory Options, Code Gen Options): + Likewise. Remove @code inside @smallexample. + 2010-09-22 Joseph Myers <joseph@codesourcery.com> * gfortranspec.c (lang_specific_driver): Handle OPT__version and diff --git a/gcc/fortran/gfortran.texi b/gcc/fortran/gfortran.texi index 10492f0..d7e656f 100644 --- a/gcc/fortran/gfortran.texi +++ b/gcc/fortran/gfortran.texi @@ -1685,7 +1685,7 @@ C @end smallexample For details refer to the g77 manual -@uref{http://gcc.gnu.org/onlinedocs/gcc-3.4.6/g77/index.html#Top}. +@uref{http://gcc.gnu.org/@/onlinedocs/@/gcc-3.4.6/@/g77/@/index.html#Top}. Also, @code{c_by_val.f} and its partner @code{c_by_val.c} of the GNU Fortran testsuite are worth a look. diff --git a/gcc/fortran/intrinsic.texi b/gcc/fortran/intrinsic.texi index 0265579..6259247 100644 --- a/gcc/fortran/intrinsic.texi +++ b/gcc/fortran/intrinsic.texi @@ -5464,7 +5464,7 @@ END PROGRAM @node GETGID @section @code{GETGID} --- Group ID function @fnindex GETGID -@cindex system, group id +@cindex system, group ID @table @asis @item @emph{Description}: @@ -5541,8 +5541,8 @@ END PROGRAM @node GETPID @section @code{GETPID} --- Process ID function @fnindex GETPID -@cindex system, process id -@cindex process id +@cindex system, process ID +@cindex process ID @table @asis @item @emph{Description}: @@ -5580,7 +5580,7 @@ end program info @node GETUID @section @code{GETUID} --- User ID function @fnindex GETUID -@cindex system, user id +@cindex system, user ID @cindex user id @table @asis @@ -6351,7 +6351,7 @@ kind. @node IMAGE_INDEX @section @code{IMAGE_INDEX} --- Function that converts a cosubscript to an image index @fnindex IMAGE_INDEX -@cindex coarray, IMAGE_INDEX +@cindex coarray, @code{IMAGE_INDEX} @cindex images, cosubscript to image index conversion @table @asis @@ -6734,7 +6734,7 @@ end program test_irand @node IS_IOSTAT_END @section @code{IS_IOSTAT_END} --- Test for end-of-file value @fnindex IS_IOSTAT_END -@cindex IOSTAT, end of file +@cindex @code{IOSTAT}, end of file @table @asis @item @emph{Description}: @@ -6760,7 +6760,7 @@ Elemental function @item @emph{Return value}: Returns a @code{LOGICAL} of the default kind, which @code{.TRUE.} if @var{I} has the value which indicates an end of file condition for -IOSTAT= specifiers, and is @code{.FALSE.} otherwise. +@code{IOSTAT=} specifiers, and is @code{.FALSE.} otherwise. @item @emph{Example}: @smallexample @@ -6779,7 +6779,7 @@ END PROGRAM @node IS_IOSTAT_EOR @section @code{IS_IOSTAT_EOR} --- Test for end-of-record value @fnindex IS_IOSTAT_EOR -@cindex IOSTAT, end of record +@cindex @code{IOSTAT}, end of record @table @asis @item @emph{Description}: @@ -6805,7 +6805,7 @@ Elemental function @item @emph{Return value}: Returns a @code{LOGICAL} of the default kind, which @code{.TRUE.} if @var{I} has the value which indicates an end of file condition for -IOSTAT= specifiers, and is @code{.FALSE.} otherwise. +@code{IOSTAT=} specifiers, and is @code{.FALSE.} otherwise. @item @emph{Example}: @smallexample @@ -9238,7 +9238,7 @@ REAL, POINTER, DIMENSION(:) :: VEC => NULL () @node NUM_IMAGES @section @code{NUM_IMAGES} --- Function that returns the number of images @fnindex NUM_IMAGES -@cindex coarray, NUM_IMAGES +@cindex coarray, @code{NUM_IMAGES} @cindex images, number of @table @asis @@ -11868,7 +11868,7 @@ end program test_tanh @node THIS_IMAGE @section @code{THIS_IMAGE} --- Function that returns the cosubscript index of this image @fnindex THIS_IMAGE -@cindex coarray, THIS_IMAGE +@cindex coarray, @code{THIS_IMAGE} @cindex images, index of this image @table @asis @@ -12625,16 +12625,16 @@ size of 16, 32, and 64 bits. It is negative if a target platform does not support the particular kind. (Fortran 2008 or later.) @item @code{IOSTAT_END}: -The value assigned to the variable passed to the IOSTAT= specifier of +The value assigned to the variable passed to the @code{IOSTAT=} specifier of an input/output statement if an end-of-file condition occurred. @item @code{IOSTAT_EOR}: -The value assigned to the variable passed to the IOSTAT= specifier of +The value assigned to the variable passed to the @code{IOSTAT=} specifier of an input/output statement if an end-of-record condition occurred. @item @code{IOSTAT_INQUIRE_INTERNAL_UNIT}: Scalar default-integer constant, used by @code{INQUIRE} for the -IOSTAT= specifier to denote an that a unit number identifies an +@code{IOSTAT=} specifier to denote an that a unit number identifies an internal unit. (Fortran 2008 or later.) @item @code{NUMERIC_STORAGE_SIZE}: diff --git a/gcc/fortran/invoke.texi b/gcc/fortran/invoke.texi index 1dfd3bd..9e2bc75 100644 --- a/gcc/fortran/invoke.texi +++ b/gcc/fortran/invoke.texi @@ -253,7 +253,7 @@ the default width of @code{DOUBLE PRECISION} to 16 bytes if possible, unless @item -fdollar-ok @opindex @code{fdollar-ok} -@cindex $ +@cindex @code{$} @cindex symbol names @cindex character set Allow @samp{$} as a valid non-first character in a symbol name. Symbols @@ -717,7 +717,7 @@ The following example will trigger the warning. @item -Wampersand @opindex @code{Wampersand} @cindex warnings, ampersand -@cindex & +@cindex @code{&} Warn about missing ampersand in continued character constants. The warning is given with @option{-Wampersand}, @option{-pedantic}, @option{-std=f95}, @option{-std=f2003} and @option{-std=f2008}. Note: With no ampersand @@ -851,10 +851,10 @@ is not included in @option{-Wall} but is implied by @option{-Wall -Wextra}. @item -Walign-commons @opindex @code{Walign-commons} -@cindex warnings, alignment of COMMON blocks -@cindex alignment of COMMON blocks +@cindex warnings, alignment of @code{COMMON} blocks +@cindex alignment of @code{COMMON} blocks By default, @command{gfortran} warns about any occasion of variables being -padded for proper alignment inside a COMMON block. This warning can be turned +padded for proper alignment inside a @code{COMMON} block. This warning can be turned off via @option{-Wno-align-commons}. See also @option{-falign-commons}. @item -Werror @@ -929,8 +929,8 @@ debugging options. @cindex directory, options @cindex options, directory search @cindex search path -@cindex INCLUDE directive -@cindex directive, INCLUDE +@cindex @code{INCLUDE} directive +@cindex directive, @code{INCLUDE} These options affect how GNU Fortran searches for files specified by the @code{INCLUDE} directive and where it searches for previously compiled modules. @@ -1313,13 +1313,13 @@ array constructors. The code below requires this option to expand the array at compile time. @smallexample -@code{program test} -@code{implicit none} -@code{integer j} -@code{integer, parameter :: n = 100000} -@code{integer, parameter :: i(n) = (/ (2*j, j = 1, n) /)} -@code{print '(10(I0,1X))', i} -@code{end program test} +program test +implicit none +integer j +integer, parameter :: n = 100000 +integer, parameter :: i(n) = (/ (2*j, j = 1, n) /) +print '(10(I0,1X))', i +end program test @end smallexample @emph{Caution: This option can lead to long compile times and excessively @@ -1427,14 +1427,14 @@ needs to be enabled (e.g. via @option{-ffpe-trap}). @item -falign-commons @opindex @code{falign-commons} -@cindex alignment of COMMON blocks +@cindex alignment of @code{COMMON} blocks By default, @command{gfortran} enforces proper alignment of all variables in a -COMMON block by padding them as needed. On certain platforms this is mandatory, -on others it increases performance. If a COMMON block is not declared with +@code{COMMON} block by padding them as needed. On certain platforms this is mandatory, +on others it increases performance. If a @code{COMMON} block is not declared with consistent data types everywhere, this padding can cause trouble, and -@option{-fno-align-commons } can be used to disable automatic alignment. The -same form of this option should be used for all files that share a COMMON block. -To avoid potential alignment issues in COMMON blocks, it is recommended to order +@option{-fno-align-commons} can be used to disable automatic alignment. The +same form of this option should be used for all files that share a @code{COMMON} block. +To avoid potential alignment issues in @code{COMMON} blocks, it is recommended to order objects from largests to smallest. @item -fno-protect-parens @@ -1442,8 +1442,8 @@ objects from largests to smallest. @cindex re-association of parenthesed expressions By default the parentheses in expression are honored for all optimization levels such that the compiler does not do any re-association. Using -@option{-fno-protect-parens} allows the compiler to reorder REAL and -COMPLEX expressions to produce faster code. Note that for the re-association +@option{-fno-protect-parens} allows the compiler to reorder @code{REAL} and +@code{COMPLEX} expressions to produce faster code. Note that for the re-association optimization @option{-fno-signed-zeros} and @option{-fno-trapping-math} need to be in effect. @end table |
