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, docs] Document --help=<language> option (PR 31355)


This patch documents the --help=<language> option.

It also fixes the fact that @var{} was erroneously used for literal values in the existing --help= documentation, and @gcctabopt was erroneously used for tables within the option listing.

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

	* doc/invoke.texi (--help=): Document <languages> value, fix
	formatting in tables of values.

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

Tested with "make info" and "make pdf" on i686-pc-linux-gnu. Ok for trunk?

- Brooks
Index: invoke.texi
===================================================================
--- invoke.texi	(revision 123170)
+++ invoke.texi	(working copy)
@@ -1100,43 +1100,48 @@
 @item --help=@var{class}@r{[},@var{qualifier}@r{]}
 Print (on the standard output) a description of the command line
 options understood by the compiler that fit into a specific class.
-The class can be one of @var{optimizers}, @var{warnings}, @var{target}
-or @var{params}:
+The class can be one of @samp{optimizers}, @samp{warnings}, @samp{target},
+@samp{params}, or @var{language}:
 
-@table @gcctabopt
-@item @var{optimizers}
+@table @asis
+@item @samp{optimizers}
 This will display all of the optimization options supported by the
 compiler.
 
-@item @var{warnings}
+@item @samp{warnings}
 This will display all of the options controlling warning messages
 produced by the compiler.
 
-@item @var{target}
+@item @samp{target}
 This will display target-specific options.  Unlike the
 @option{--target-help} option however, target-specific options of the
 linker and assembler will not be displayed.  This is because those
 tools do not currently support the extended @option{--help=} syntax.
 
-@item @var{params}
+@item @samp{params}
 This will display the values recognized by the @option{--param}
 option.
+
+@item @var{language}
+This will display the options supported for @var{language}, where 
+@var{language} is the name of one of the languages supported in this 
+version of GCC.
 @end table
 
 It is possible to further refine the output of the @option{--help=}
 option by adding a comma separated list of qualifiers after the
 class.  These can be any from the following list:
 
-@table @gcctabopt
-@item undocumented
+@table @asis
+@item @samp{undocumented}
 Display only those options which are undocumented.
 
-@item joined
+@item @samp{joined}
 Display options which take an argument that appears after an equal
 sign in the same continuous piece of text, such as:
 @samp{--help=target}.
 
-@item separate
+@item @samp{separate}
 Display options which take an argument that appears as a separate word
 following the original option, such as: @samp{-o output-file}.
 @end table

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