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 for documentation formatting


This patch fixes various miscellaneous Texinfo formatting issues that have 
crept into the manuals.  It passes "make info" and "make dvi".  Applied to 
mainline.

-- 
Joseph S. Myers               http://www.srcf.ucam.org/~jsm28/gcc/
    jsm@polyomino.org.uk (personal mail)
    joseph@codesourcery.com (CodeSourcery mail)
    jsm28@gcc.gnu.org (Bugzilla assignments and CCs)

Index: ChangeLog
===================================================================
RCS file: /cvs/gcc/gcc/gcc/ChangeLog,v
retrieving revision 2.6061
diff -u -r2.6061 ChangeLog
--- ChangeLog	28 Oct 2004 00:20:17 -0000	2.6061
+++ ChangeLog	28 Oct 2004 00:57:55 -0000
@@ -1,5 +1,12 @@
 2004-10-28  Joseph S. Myers  <jsm@polyomino.org.uk>
 
+	* doc/contrib.texi, doc/cpp.texi, doc/cppopts.texi,
+	doc/extend.texi, doc/gcov.texi, doc/install.texi, doc/invoke.texi,
+	doc/libgcc.texi, doc/md.texi, doc/passes.texi,
+	doc/sourcebuild.texi, doc/tm.texi: Improve Texinfo formatting.
+
+2004-10-28  Joseph S. Myers  <jsm@polyomino.org.uk>
+
 	* doc/c-tree.texi, doc/cpp.texi, doc/implement-c.texi,
 	doc/invoke.texi, doc/md.texi, doc/passes.texi, doc/tm.texi: Put
 	punctuation outside quotes.
Index: doc/contrib.texi
===================================================================
RCS file: /cvs/gcc/gcc/gcc/doc/contrib.texi,v
retrieving revision 1.58
diff -u -r1.58 contrib.texi
--- doc/contrib.texi	10 Jul 2004 21:11:54 -0000	1.58
+++ doc/contrib.texi	28 Oct 2004 00:57:55 -0000
@@ -215,15 +215,15 @@
 @item
 Gabriel Dos Reis for contributions to G++, contributions and
 maintenance of GCC diagnostics infrastructure, libstdc++-v3,
-including valarray<>, complex<>, maintaining the numerics library
-(including that pesky <limits> :-) and keeping up-to-date anything
+including @code{valarray<>}, @code{complex<>}, maintaining the numerics library
+(including that pesky @code{<limits>} :-) and keeping up-to-date anything
 to do with numbers.
 
 @item
 Ulrich Drepper for his work on glibc, testing of GCC using glibc, ISO C99
 support, CFG dumping support, etc., plus support of the C++ runtime
 libraries including for all kinds of C interface issues, contributing and
-maintaining complex<>, sanity checking and disbursement, configuration
+maintaining @code{complex<>}, sanity checking and disbursement, configuration
 architecture, libio maintenance, and early math work.
 
 @item
@@ -582,7 +582,7 @@
 Jason Molenda for major help in the care and feeding of all the services
 on the gcc.gnu.org (formerly egcs.cygnus.com) machine---mail, web
 services, ftp services, etc etc.  Doing all this work on scrap paper and
-the backs of envelopes would have been... difficult.
+the backs of envelopes would have been@dots{} difficult.
 
 @item
 Catherine Moore for fixing various ugly problems we have sent her
@@ -767,9 +767,9 @@
 GCC 2.95.3.
 
 @item
-Peter Schmid for constant testing of libstdc++ -- especially application
+Peter Schmid for constant testing of libstdc++---especially application
 testing, going above and beyond what was requested for the release
-criteria -- and libstdc++ header file tweaks.
+criteria---and libstdc++ header file tweaks.
 
 @item
 Jason Schroeder for jcf-dump patches.
Index: doc/cpp.texi
===================================================================
RCS file: /cvs/gcc/gcc/gcc/doc/cpp.texi,v
retrieving revision 1.73
diff -u -r1.73 cpp.texi
--- doc/cpp.texi	28 Oct 2004 00:20:41 -0000	1.73
+++ doc/cpp.texi	28 Oct 2004 00:57:57 -0000
@@ -901,7 +901,7 @@
 quote marks.  Directories after @option{-I-} are searched for all
 headers.  Second, the directory containing the current file is not
 searched for anything, unless it happens to be one of the directories
-named by an @option{-I} switch.  @option{-I-} is deprecated, -iquote
+named by an @option{-I} switch.  @option{-I-} is deprecated, @option{-iquote}
 should be used instead.
 
 @option{-I. -I-} is not the same as no @option{-I} options at all, and does
@@ -3807,10 +3807,10 @@
 compiler issues a warning, and the excess leading characters are
 ignored.
 
-For example, 'ab' for a target with an 8-bit @code{char} would be
-interpreted as @w{(int) ((unsigned char) 'a' * 256 + (unsigned char)
-'b')}, and '\234a' as @w{(int) ((unsigned char) '\234' * 256 + (unsigned
-char) 'a')}.
+For example, @code{'ab'} for a target with an 8-bit @code{char} would be
+interpreted as @w{@samp{(int) ((unsigned char) 'a' * 256 + (unsigned char)
+'b')}}, and @code{'\234a'} as @w{@samp{(int) ((unsigned char) '\234' *
+256 + (unsigned char) 'a')}}.
 
 @item Source file inclusion.
 
Index: doc/cppopts.texi
===================================================================
RCS file: /cvs/gcc/gcc/gcc/doc/cppopts.texi,v
retrieving revision 1.36
diff -u -r1.36 cppopts.texi
--- doc/cppopts.texi	17 Sep 2004 08:22:37 -0000	1.36
+++ doc/cppopts.texi	28 Oct 2004 00:57:57 -0000
@@ -314,7 +314,7 @@
 @item -MMD
 @opindex MMD
 Like @option{-MD} except mention only user header files, not system
--header files.
+header files.
 
 @ifclear cppmanual
 @item -fpch-deps
Index: doc/extend.texi
===================================================================
RCS file: /cvs/gcc/gcc/gcc/doc/extend.texi,v
retrieving revision 1.226
diff -u -r1.226 extend.texi
--- doc/extend.texi	19 Oct 2004 23:17:06 -0000	1.226
+++ doc/extend.texi	28 Oct 2004 00:58:00 -0000
@@ -1667,7 +1667,7 @@
 using thunks.
 
 On the SH Symbian OS target the @code{dllimport} attribute also has
-another affect - it can cause the vtable and run-time type information
+another affect---it can cause the vtable and run-time type information
 for a class to be exported.  This happens when the class has a
 dllimport'ed constructor or a non-inline, non-pure virtual function
 and, for either of those two conditions, the class also has a inline
@@ -2780,7 +2780,7 @@
 @opindex fno-common
 The @code{common} attribute requests GCC to place a variable in
 ``common'' storage.  The @code{nocommon} attribute requests the
-opposite -- to allocate space for it directly.
+opposite---to allocate space for it directly.
 
 These attributes override the default chosen by the
 @option{-fno-common} and @option{-fcommon} flags respectively.
@@ -3159,7 +3159,7 @@
 
 In the following example @code{struct my_packed_struct}'s members are
 packed closely together, but the internal layout of its @code{s} member
-is not packed -- to do that, @code{struct my_unpacked_struct} would need to
+is not packed---to do that, @code{struct my_unpacked_struct} would need to
 be packed too.
 
 @smallexample
Index: doc/gcov.texi
===================================================================
RCS file: /cvs/gcc/gcc/gcc/doc/gcov.texi,v
retrieving revision 1.22
diff -u -r1.22 gcov.texi
--- doc/gcov.texi	14 Mar 2004 22:29:37 -0000	1.22
+++ doc/gcov.texi	28 Oct 2004 00:58:00 -0000
@@ -184,9 +184,10 @@
 @itemx --preserve-paths
 Preserve complete path information in the names of generated
 @file{.gcov} files. Without this option, just the filename component is
-used. With this option, all directories are used, with '/' characters
-translated to '#' characters, '.' directory components removed and '..'
-components renamed to '^'. This is useful if sourcefiles are in several
+used. With this option, all directories are used, with @samp{/} characters
+translated to @samp{#} characters, @file{.} directory components
+removed and @file{..}
+components renamed to @samp{^}. This is useful if sourcefiles are in several
 different directories. It also affects the @samp{-l} option.
 
 @item -f
@@ -222,7 +223,7 @@
 be something more complicated if the @samp{-l} or @samp{-p} options are
 given. Refer to those options for details.
 
-The @file{.gcov} files contain the ':' separated fields along with
+The @file{.gcov} files contain the @samp{:} separated fields along with
 program source code. The format is
 
 @smallexample
Index: doc/install.texi
===================================================================
RCS file: /cvs/gcc/gcc/gcc/doc/install.texi,v
retrieving revision 1.323
diff -u -r1.323 install.texi
--- doc/install.texi	26 Oct 2004 18:20:34 -0000	1.323
+++ doc/install.texi	28 Oct 2004 00:58:02 -0000
@@ -670,7 +670,7 @@
 For native builds, some of the installed programs are also installed
 with the target alias in front of their name, as in
 @samp{i686-pc-linux-gnu-gcc}. All of the above transformations happen
-before the target alias is prepended to the name - so, specifying
+before the target alias is prepended to the name---so, specifying
 @option{--program-prefix=foo-} and @option{program-suffix=-3.1}, the
 resulting binary would be installed as
 @file{/usr/local/bin/i686-pc-linux-gnu-foo-gcc-3.1}.
@@ -702,7 +702,7 @@
 another directory which is based on the @option{--prefix} value.)
 
 Both the local-prefix include directory and the GCC-prefix include
-directory are part of GCC's "system include" directories.  Although these
+directory are part of GCC's ``system include'' directories.  Although these
 two directories are not fixed, they need to be searched in the proper
 order for the correct processing of the include_next directive.  The
 local-prefix include directory is searched before the GCC-prefix
@@ -2882,7 +2882,7 @@
 Supplement OSS631C or later.  If you are using release 5.0.7 of
 OpenServer, you must have at least the first maintenance pack installed
 (this includes the relevant portions of OSS646).  OSS646, also known as
-the "Execution Environment Update", provides updated link editors and
+the ``Execution Environment Update'', provides updated link editors and
 assemblers, as well as updated standard C and math libraries.  The C
 startup modules are also updated to support the System V gABI draft, and
 GCC relies on that behavior.  OSS631 provides a collection of commonly
@@ -2902,8 +2902,8 @@
 testing.  In general, only the @option{--with-gnu-as} option is tested.
 A modern bintuils (as well as a plethora of other development related
 GNU utilities) can be found in Support Level Supplement OSS658A, the
-"GNU Development Tools" package.  See the SCO web and ftp sites for details.
-That package also contains the currently "officially supported" version of
+``GNU Development Tools'' package.  See the SCO web and ftp sites for details.
+That package also contains the currently ``officially supported'' version of
 GCC, version 2.95.3.  It is useful for bootstrapping this version.
 
 @html
Index: doc/invoke.texi
===================================================================
RCS file: /cvs/gcc/gcc/gcc/doc/invoke.texi,v
retrieving revision 1.550
diff -u -r1.550 invoke.texi
--- doc/invoke.texi	28 Oct 2004 00:20:41 -0000	1.550
+++ doc/invoke.texi	28 Oct 2004 00:58:06 -0000
@@ -961,14 +961,16 @@
 to pass all the source files to the compiler at once (for those
 languages for which the compiler can handle this).  This will allow
 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
-language for which this is supported is C.  If you pass source files for
+language for which this is supported is C@.  If you pass source files for
 multiple languages to the driver, using this option, the driver will invoke
 the compiler(s) that support IMA once each, passing each compiler all the
 source files appropriate for it.  For those languages that do not support
 IMA this option will be ignored, and the compiler will be invoked once for
 each source file in that language.  If you use this option in conjunction
-with -save-temps, the compiler will generate multiple pre-processed files
-(one for each source file), but only one (combined) .o or .s file.
+with @option{-save-temps}, the compiler will generate multiple
+pre-processed files
+(one for each source file), but only one (combined) @file{.o} or
+@file{.s} file.
 
 @item --help
 @opindex help
@@ -3957,7 +3959,7 @@
 To resolve this you either need to put @file{cpp0} and the other compiler
 components where @command{gcc} expects to find them, or you can set the environment
 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
-Don't forget the trailing '/'.
+Don't forget the trailing @samp{/}.
 @xref{Environment Variables}.
 
 @item -dumpmachine
@@ -5182,7 +5184,7 @@
 With @option{-fbranch-probabilities}, it reads back the data gathered
 and issues prefetch instructions according to them.  In addition to the opportunities
 noticed by @option{-fprefetch-loop-arrays}, it also notices more complicated
-memory access patterns -- for example accesses to the data stored in linked
+memory access patterns---for example accesses to the data stored in linked
 list whose elements are usually allocated sequentially.
 
 In order to prevent issuing double prefetches, usage of
@@ -12146,7 +12148,7 @@
 
 @item -fvisibility=@var{default|internal|hidden|protected}
 @opindex fvisibility
-Set the default ELF image symbol visibility to the specified option - all
+Set the default ELF image symbol visibility to the specified option---all
 symbols will be marked with this unless overridden within the code.
 Using this feature can very substantially improve linking and
 load times of shared object libraries, produce more optimized
@@ -12158,14 +12160,15 @@
 available to be linked against from outside the shared object.
 @code{protected} and @code{internal} are pretty useless in real-world
 usage so the only other commonly used option will be @code{hidden}.
-The default if -fvisibility isn't specified is @code{default} ie; make every
-symbol public - this causes the same behavior as previous versions of
+The default if @option{-fvisibility} isn't specified is
+@code{default}, i.e., make every
+symbol public---this causes the same behavior as previous versions of
 GCC.
      
 A good explanation of the benefits offered by ensuring ELF
 symbols have the correct visibility is given by ``How To Write
 Shared Libraries'' by Ulrich Drepper (which can be found at
-@w{@uref{http://people.redhat.com/~drepper/}}) - however a superior
+@w{@uref{http://people.redhat.com/~drepper/}})---however a superior
 solution made possible by this option to marking things hidden when
 the default is public is to make the default hidden and mark things
 public. This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
@@ -12183,7 +12186,7 @@
 part of the API interface contract} and thus all new code should
 always specify visibility when it is not the default ie; declarations
 only for use within the local DSO should @strong{always} be marked explicitly
-as hidden as so to avoid PLT indirection overheads - making this
+as hidden as so to avoid PLT indirection overheads---making this
 abundantly clear also aids readability and self-documentation of the code.
 Note that due to ISO C++ specification requirements, operator new and
 operator delete must always be of default visibility.
Index: doc/libgcc.texi
===================================================================
RCS file: /cvs/gcc/gcc/gcc/doc/libgcc.texi,v
retrieving revision 1.6
diff -u -r1.6 libgcc.texi
--- doc/libgcc.texi	18 Jan 2004 11:57:13 -0000	1.6
+++ doc/libgcc.texi	28 Oct 2004 00:58:07 -0000
@@ -364,7 +364,7 @@
 @deftypefnx {Runtime Function} int __cmpdf2 (double @var{a}, double @var{b})
 @deftypefnx {Runtime Function} int __cmptf2 (long double @var{a}, long double @var{b})
 These functions calculate @math{a <=> b}.  That is, if @var{a} is less
-than @var{b}, they return -1; if @var{a} is greater than @var{b}, they
+than @var{b}, they return @minus{}1; if @var{a} is greater than @var{b}, they
 return 1; and if @var{a} and @var{b} are equal they return 0.  If
 either argument is NaN they return 1, but you should not rely on this;
 if NaN is a possibility, use one of the higher-level comparison
Index: doc/md.texi
===================================================================
RCS file: /cvs/gcc/gcc/gcc/doc/md.texi,v
retrieving revision 1.113
diff -u -r1.113 md.texi
--- doc/md.texi	28 Oct 2004 00:20:42 -0000	1.113
+++ doc/md.texi	28 Oct 2004 00:58:09 -0000
@@ -1962,7 +1962,7 @@
 The constant zero
 
 @item P
-0 or -1 for @code{dep} instruction
+0 or @minus{}1 for @code{dep} instruction
 
 @item Q
 Non-volatile memory for floating-point loads and stores
@@ -2103,7 +2103,7 @@
 Non-SP registers (everything except @samp{SP})
 
 @item R
-Indirect through @samp{IP} - Avoid this except for @code{QImode}, since we
+Indirect through @samp{IP}---Avoid this except for @code{QImode}, since we
 can't access extra bytes
 
 @item S
@@ -2234,13 +2234,13 @@
 @item Motorola 68HC11 & 68HC12 families---@file{m68hc11.h}
 @table @code
 @item a
-Register 'a'
+Register `a'
 
 @item b
-Register 'b'
+Register `b'
 
 @item d
-Register 'd'
+Register `d'
 
 @item q
 An 8-bit register
@@ -2255,13 +2255,13 @@
 Stack pointer register
 
 @item x
-Register 'x'
+Register `x'
 
 @item y
-Register 'y'
+Register `y'
 
 @item z
-Pseudo register 'z' (replaced by 'x' or 'y' at the end)
+Pseudo register `z' (replaced by `x' or `y' at the end)
 
 @item A
 An address register: x, y or z
@@ -2495,7 +2495,7 @@
          @item D,S,H:
          mode of the containing operand
          @item 0,F:
-         value of the other parts (F - all bits set)
+         value of the other parts (F---all bits set)
 @end table
 The constraint matches if the specified part of a constant
 has a value different from it's other parts.
Index: doc/passes.texi
===================================================================
RCS file: /cvs/gcc/gcc/gcc/doc/passes.texi,v
retrieving revision 1.44
diff -u -r1.44 passes.texi
--- doc/passes.texi	28 Oct 2004 00:20:42 -0000	1.44
+++ doc/passes.texi	28 Oct 2004 00:58:09 -0000
@@ -151,7 +151,7 @@
 and take care of standard bookkeeping that applies to every pass.
 
 The theory of operation is that each pass defines a structure that
-represents everything we need to know about that pass --- when it
+represents everything we need to know about that pass---when it
 should be run, how it should be run, what intermediate language 
 form or on-the-side data structures it needs.  We register the pass
 to be run in some particular order, and the pass manager arranges
Index: doc/sourcebuild.texi
===================================================================
RCS file: /cvs/gcc/gcc/gcc/doc/sourcebuild.texi,v
retrieving revision 1.58
diff -u -r1.58 sourcebuild.texi
--- doc/sourcebuild.texi	17 Sep 2004 08:22:49 -0000	1.58
+++ doc/sourcebuild.texi	28 Oct 2004 00:58:10 -0000
@@ -648,7 +648,7 @@
 
 @item lang.opt
 This file registers the set of switches that the front end accepts on
-the command line, and their --help text.  The file format is
+the command line, and their @option{--help} text.  The file format is
 documented in the file @file{c.opt}.  These files are processed by the
 script @file{opts.sh}.
 @item lang-specs.h
@@ -928,9 +928,10 @@
 There is also an extra chapter called @file{gcc} containing a template for
 creating new executable tests.
 
-The tests are run using two 'sh' scripts: run_acats and run_all.sh
-To run the tests using a simulator or a cross target, see the small
-customization section at the top of run_all.sh
+The tests are run using two @command{sh} scripts: @file{run_acats} and
+@file{run_all.sh}.  To run the tests using a simulator or a cross
+target, see the small
+customization section at the top of @file{run_all.sh}.
 
 These tests are run using the build tree: they can be run without doing
 a @code{make install}.
Index: doc/tm.texi
===================================================================
RCS file: /cvs/gcc/gcc/gcc/doc/tm.texi,v
retrieving revision 1.387
diff -u -r1.387 tm.texi
--- doc/tm.texi	28 Oct 2004 00:20:42 -0000	1.387
+++ doc/tm.texi	28 Oct 2004 00:58:13 -0000
@@ -3811,7 +3811,7 @@
 being compiled.  @var{n_named_args} is set to the number of named
 arguments, including a structure return address if it is passed as a
 parameter, when making a call.  When processing incoming arguments,
-@var{n_named_args} is set to -1.
+@var{n_named_args} is set to @minus{}1.
 
 When processing a call to a compiler support library function,
 @var{libname} identifies which one.  It is a @code{symbol_ref} rtx which
@@ -4830,7 +4830,7 @@
 operand is smaller than the second, 1 to indicate that they are equal,
 and 2 to indicate that the first operand is greater than the second.
 If this macro evalutes to @code{false} the comparison functions return
--1, 0, and 1 instead of 0, 1, and 2.  If the target uses the routines
+@minus{}1, 0, and 1 instead of 0, 1, and 2.  If the target uses the routines
 in @file{libgcc.a}, you do not need to define this macro.
 @end defmac
 
@@ -5829,7 +5829,7 @@
 delays, however: (b) there's a better chance to predict the actual grouping
 that will be formed, and (c) correctly emulating the grouping can be very
 important.  In such targets one may want to allow issuing dependent insns
-closer to one another - i.e, closer than the dependence distance;  however,
+closer to one another---i.e., closer than the dependence distance;  however,
 not in cases of "costly dependences", which this hooks allows to define.
 @end deftypefn
 
@@ -8360,8 +8360,8 @@
 initializer for an array of integers.  Each initializer element
 N refers to an entity that needs mode switching, and specifies the number
 of different modes that might need to be set for this entity.
-The position of the initializer in the initializer - starting counting at
-zero - determines the integer that is used to refer to the mode-switched
+The position of the initializer in the initializer---starting counting at
+zero---determines the integer that is used to refer to the mode-switched
 entity in question.
 In macros that take mode arguments / yield a mode result, modes are
 represented as numbers 0 @dots{} N @minus{} 1.  N is used to specify that no mode
@@ -8599,7 +8599,7 @@
 @deftypefn {Target Hook} int TARGET_CXX_IMPORT_EXPORT_CLASS (tree  @var{type}, int @var{import_export})
 If defined by a backend this hook allows the decision made to export
 class @var{type} to be overruled.  Upon entry @var{import_export}
-will contain 1 if the class is going to be exported, -1 if it is going
+will contain 1 if the class is going to be exported, @minus{}1 if it is going
 to be imported and 0 otherwise.  This function should return the
 modified value and perform any other actions necessary to support the
 backend's targeted operating system.


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