cpp.texi: Exclude entire Top node from printed manual.
authorZack Weinberg <zack@codesourcery.com>
Tue, 26 Mar 2002 03:25:05 +0000 (03:25 +0000)
committerZack Weinberg <zack@gcc.gnu.org>
Tue, 26 Mar 2002 03:25:05 +0000 (03:25 +0000)
* doc/cpp.texi: Exclude entire Top node from printed manual.
Move option index after directive index.  Insert page breaks
before GFDL and concept index.  Index environment variables
with command line options.
* doc/cppenv.texi: Use @vtable for environment variable list.
Add paragraph explaining semantics of empty elements in path
variables.  Exclude a cross-reference to Fishkill from the
manpage.  Remove an unnecessary cross-reference of the entry
right above the referer.  Don't use @anchor in text that goes
into manpage.
* doc/cppopts.texi: Cross-reference the environment variables
section, not the specific environment variable, for consistency.

From-SVN: r51365

gcc/ChangeLog
gcc/doc/cpp.texi
gcc/doc/cppenv.texi
gcc/doc/cppopts.texi

index e030917..834bdff 100644 (file)
@@ -1,3 +1,18 @@
+2002-03-25  Zack Weinberg  <zack@codesourcery.com>
+
+       * doc/cpp.texi: Exclude entire Top node from printed manual.
+       Move option index after directive index.  Insert page breaks
+       before GFDL and concept index.  Index environment variables
+       with command line options.
+       * doc/cppenv.texi: Use @vtable for environment variable list.
+       Add paragraph explaining semantics of empty elements in path
+       variables.  Exclude a cross-reference to Fishkill from the
+       manpage.  Remove an unnecessary cross-reference of the entry
+       right above the referer.  Don't use @anchor in text that goes
+       into manpage.
+       * doc/cppopts.texi: Cross-reference the environment variables
+       section, not the specific environment variable, for consistency.
+
 2002-03-25  Richard Henderson  <rth@redhat.com>
 
        * recog.c (peephole2_optimize): Distribute EH_REGION -1 notes
index 77745e7..260efdc 100644 (file)
@@ -9,7 +9,7 @@
 @macro copyrightnotice
 @c man begin COPYRIGHT
 Copyright @copyright{} 1987, 1989, 1991, 1992, 1993, 1994, 1995, 1996,
-1997, 1998, 1999, 2000, 2001
+1997, 1998, 1999, 2000, 2001, 2002
 Free Software Foundation, Inc.
 
 Permission is granted to copy, distribute and/or modify this document
@@ -48,6 +48,7 @@ This manual contains no Invariant Sections.  The Front-Cover Texts are
 
 @c Create a separate index for command line options.
 @defcodeindex op
+@syncodeindex vr op
 
 @c Used in cppopts.texi and cppenv.texi.
 @set cppmanual
@@ -75,6 +76,7 @@ This manual contains no Invariant Sections.  The Front-Cover Texts are
 @contents
 @page
 
+@ifnottex
 @node Top
 @top
 The C preprocessor implements the macro language used to transform C,
@@ -96,8 +98,8 @@ useful on its own.
 * Invocation::
 * Environment Variables::
 * GNU Free Documentation License::
-* Option Index::
 * Index of Directives::
+* Option Index::
 * Concept Index::
 
 @detailmenu
@@ -179,7 +181,6 @@ Obsolete Features
 @end detailmenu
 @end menu
 
-@ifnottex
 @copyrightnotice{}
 @covertexts{}
 @end ifnottex
@@ -3949,21 +3950,22 @@ configuration of GCC@.
 @include cppenv.texi
 @c man end
 
+@page
 @include fdl.texi
 
 @page
-@node Option Index
-@unnumbered Option Index
-
-CPP's command line options are indexed here without any initial
-@samp{-} or @samp{--}.
-
-@printindex op
-
 @node Index of Directives
 @unnumbered Index of Directives
 @printindex fn
 
+@node Option Index
+@unnumbered Option Index
+@noindent
+CPP's command line options and environment variables are indexed here
+without any initial @samp{-} or @samp{--}.
+@printindex op
+
+@page
 @node Concept Index
 @unnumbered Concept Index
 @printindex cp
index 31407bd..a233313 100644 (file)
@@ -10,7 +10,7 @@
 @c If this file is included with the flag ``cppmanual'' set, it is
 @c formatted for inclusion in the CPP manual; otherwise the main GCC manual.
 
-@ftable @env
+@vtable @env
 @item CPATH
 @itemx C_INCLUDE_PATH
 @itemx CPLUS_INCLUDE_PATH
@@ -25,7 +25,7 @@ semicolon, and for almost all other targets it is a colon.
 
 @env{CPATH} specifies a list of directories to be searched as if
 specified with @option{-I}, but after any paths given with @option{-I}
-options on the command line.  The environment variable is used
+options on the command line.  This environment variable is used
 regardless of which language is being preprocessed.
 
 The remaining environment variables apply only when preprocessing the
@@ -33,12 +33,19 @@ particular language indicated.  Each specifies a list of directories
 to be searched as if specified with @option{-isystem}, but after any
 paths given with @option{-isystem} options on the command line.
 
+In all these variables, an empty element instructs the compiler to
+search its current working directory.  Empty elements can appear at the
+beginning or end of a path.  For instance, if the value of
+@env{CPATH} is @code{:/special/include}, that has the same
+effect as @samp{@w{-I. -I/special/include}}.
+
+@c man end
 @ifset cppmanual
 See also @ref{Search Path}.
 @end ifset
+@c man begin ENVIRONMENT
 
 @item DEPENDENCIES_OUTPUT
-@anchor{DEPENDENCIES_OUTPUT}
 @cindex dependencies for make as output
 If this variable is set, its value specifies how to output
 dependencies for Make based on the non-system header files processed
@@ -63,14 +70,13 @@ with an optional @option{-MT} switch too.
 
 @item SUNPRO_DEPENDENCIES
 @cindex dependencies for make as output
-This variable is the same as the environment variable
-@env{DEPENDENCIES_OUTPUT} (@pxref{DEPENDENCIES_OUTPUT}), except that
-system header files are not ignored, so it implies @option{-M} rather
-than @option{-MM}.
+This variable is the same as @env{DEPENDENCIES_OUTPUT} (see above),
+except that system header files are not ignored, so it implies
+@option{-M} rather than @option{-MM}.
 @ifset cppmanual
 @xref{Invocation}.
 @end ifset
 @ifclear cppmanual
 @xref{Preprocessor Options}.
 @end ifclear
-@end ftable
+@end vtable
index 7ab651b..5958abd 100644 (file)
@@ -175,7 +175,7 @@ This option does not suppress the preprocessor's debug output, such as
 @option{-dM}.  To avoid mixing such debug output with the dependency
 rules you should explicitly specify the dependency output file with
 @option{-MF}, or use an environment variable like
-@env{DEPENDENCIES_OUTPUT} (@pxref{DEPENDENCIES_OUTPUT}).  Debug output
+@env{DEPENDENCIES_OUTPUT} (@pxref{Environment Variables}).  Debug output
 will still be sent to the regular output stream as normal.
 
 Passing @option{-M} to the driver implies @option{-E}.