Patchwork [doc] : @var fixes.

login
register
mail settings
Submitter Ralf Wildenhues
Date Dec. 19, 2010, 1 p.m.
Message ID <20101219130013.GN7020@gmx.de>
Download mbox | patch
Permalink /patch/76123/
State New
Headers show

Comments

Ralf Wildenhues - Dec. 19, 2010, 1 p.m.
Tested 'make pdf html info'.  OK for trunk?

Thanks,
Ralf

doc: @var fixes.

gcc/ChangeLog:
2010-12-19  Ralf Wildenhues  <Ralf.Wildenhues@gmx.de>

	* doc/cppopts.texi: Use @var when appropriate.
	* doc/extend.texi (Structure-Packing Pragmas): Likewise.
	* doc/gimple.texi (Logical Operators)
	(Adding a new GIMPLE statement code): Likewise.
	* doc/invoke.texi (Target Options, Precompiled Headers):
	Likewise.
	* doc/plugins.texi (Plugins): Likewise.
	* doc/tm.texi.in (Misc): Likewise.
	* doc/tm.texi: Regenerate.
Joseph S. Myers - Dec. 19, 2010, 2:13 p.m.
On Sun, 19 Dec 2010, Ralf Wildenhues wrote:

> Tested 'make pdf html info'.  OK for trunk?

OK (for the diff you sent).

> 	* doc/tm.texi.in (Misc): Likewise.
> 	* doc/tm.texi: Regenerate.

These don't appear in the diff.
Ralf Wildenhues - Dec. 19, 2010, 2:16 p.m.
* Joseph S. Myers wrote on Sun, Dec 19, 2010 at 03:13:13PM CET:
> On Sun, 19 Dec 2010, Ralf Wildenhues wrote:
> 
> > Tested 'make pdf html info'.  OK for trunk?
> 
> OK (for the diff you sent).
> 
> > 	* doc/tm.texi.in (Misc): Likewise.
> > 	* doc/tm.texi: Regenerate.
> 
> These don't appear in the diff.

Thanks.  The patch is a bit older, and apparently this hunk was
obsoleted in the meantime.

Cheers,
Ralf

Patch

diff --git a/gcc/doc/cppopts.texi b/gcc/doc/cppopts.texi
index 57624ed..5212478 100644
--- a/gcc/doc/cppopts.texi
+++ b/gcc/doc/cppopts.texi
@@ -330,10 +330,10 @@  header is used.
 @opindex fpch-preprocess
 This option allows use of a precompiled header (@pxref{Precompiled
 Headers}) together with @option{-E}.  It inserts a special @code{#pragma},
-@code{#pragma GCC pch_preprocess "<filename>"} in the output to mark
-the place where the precompiled header was found, and its filename.  When
-@option{-fpreprocessed} is in use, GCC recognizes this @code{#pragma} and
-loads the PCH@.
+@code{#pragma GCC pch_preprocess "@var{filename}"} in the output to mark
+the place where the precompiled header was found, and its @var{filename}.
+When @option{-fpreprocessed} is in use, GCC recognizes this @code{#pragma}
+and loads the PCH@.
 
 This option is off by default, because the resulting preprocessed output
 is only really suitable as input to GCC@.  It is switched on by
diff --git a/gcc/doc/extend.texi b/gcc/doc/extend.texi
index e1bbe6b..1ac1d8d 100644
--- a/gcc/doc/extend.texi
+++ b/gcc/doc/extend.texi
@@ -12989,7 +12989,7 @@  to be a small power of two and specifies the new alignment in bytes.
 @item @code{#pragma pack(@var{n})} simply sets the new alignment.
 @item @code{#pragma pack()} sets the alignment to the one that was in
 effect when compilation started (see also command-line option
-@option{-fpack-struct[=<n>]} @pxref{Code Gen Options}).
+@option{-fpack-struct[=@var{n}]} @pxref{Code Gen Options}).
 @item @code{#pragma pack(push[,@var{n}])} pushes the current alignment
 setting on an internal stack and then optionally sets the new alignment.
 @item @code{#pragma pack(pop)} restores the alignment setting to the one
diff --git a/gcc/doc/gimple.texi b/gcc/doc/gimple.texi
index 5e217a7..e8cecd7 100644
--- a/gcc/doc/gimple.texi
+++ b/gcc/doc/gimple.texi
@@ -635,7 +635,7 @@  access the operands.
 When adding a new operand to a gimple statement, the operand will
 be validated according to what each tuple accepts in its operand
 vector.  These predicates are called by the
-@code{gimple_<name>_set_...()}.  Each tuple will use one of the
+@code{gimple_@var{name}_set_...()}.  Each tuple will use one of the
 following predicates (Note, this list is not exhaustive):
 
 @deftypefn {GIMPLE function} is_gimple_operand (tree t)
@@ -2497,7 +2497,7 @@  in @code{gimple.c}.
 
 You will probably want to create a function to build the new
 gimple statement in @code{gimple.c}.  The function should be called
-@code{gimple_build_<@code{NEW_TUPLE_NAME}>}, and should return the new tuple
+@code{gimple_build_@var{new-tuple-name}}, and should return the new tuple
 of type gimple.
 
 If your new statement requires accessors for any members or
diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
index 7992c1d..66bd124 100644
--- a/gcc/doc/invoke.texi
+++ b/gcc/doc/invoke.texi
@@ -9856,10 +9856,10 @@  proper position among the other output files.
 @cindex compiler version, specifying
 @cindex target machine, specifying
 
-The usual way to run GCC is to run the executable called @file{gcc}, or
-@file{<machine>-gcc} when cross-compiling, or
-@file{<machine>-gcc-<version>} to run a version other than the one that
-was installed last.
+The usual way to run GCC is to run the executable called @command{gcc}, or
+@command{@var{machine}-gcc} when cross-compiling, or
+@command{@var{machine}-gcc-@var{version}} to run a version other than the
+one that was installed last.
 
 @node Submodel Options
 @section Hardware Models and Configurations
@@ -18479,7 +18479,7 @@  precompiled header.  The following are known to be safe:
 
 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
--fsched-verbose=<number>  -fschedule-insns  -fvisibility= @gol
+-fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
 -pedantic-errors}
 
 @end itemize
diff --git a/gcc/doc/plugins.texi b/gcc/doc/plugins.texi
index 5a56042..767cee8 100644
--- a/gcc/doc/plugins.texi
+++ b/gcc/doc/plugins.texi
@@ -16,16 +16,16 @@  process.
 
 Plugins are loaded with 
 
-@option{-fplugin=/path/to/NAME.so} @option{-fplugin-arg-NAME-<key1>[=<value1>]}
+@option{-fplugin=/path/to/@var{name}.so} @option{-fplugin-arg-@var{name}-@var{key1}[=@var{value1}]}
 
 The plugin arguments are parsed by GCC and passed to respective
 plugins as key-value pairs. Multiple plugins can be invoked by
 specifying multiple @option{-fplugin} arguments.
 
 A plugin can be simply given by its short name (no dots or
-slashes). When simply passing @option{-fplugin=NAME}, the plugin is
-loaded from the @file{plugin} directory, so @option{-fplugin=NAME} is
-the same as @option{-fplugin=`gcc -print-file-name=plugin`/NAME.so},
+slashes). When simply passing @option{-fplugin=@var{name}}, the plugin is
+loaded from the @file{plugin} directory, so @option{-fplugin=@var{name}} is
+the same as @option{-fplugin=`gcc -print-file-name=plugin`/@var{name}.so},
 using backquote shell syntax to query the @file{plugin} directory.
 
 @section Plugin API
@@ -45,8 +45,8 @@  If this symbol does not exist, the compiler will emit a fatal error
 and exit with the error message:
 
 @smallexample
-fatal error: plugin <name> is not licensed under a GPL-compatible license
-<name>: undefined symbol: plugin_is_GPL_compatible
+fatal error: plugin @var{name} is not licensed under a GPL-compatible license
+@var{name}: undefined symbol: plugin_is_GPL_compatible
 compilation terminated
 @end smallexample