summaryrefslogtreecommitdiff
path: root/gcc
diff options
context:
space:
mode:
authorrwild <rwild@138bc75d-0d04-0410-961f-82ee72b054a4>2010-12-20 07:26:12 +0000
committerrwild <rwild@138bc75d-0d04-0410-961f-82ee72b054a4>2010-12-20 07:26:12 +0000
commitc23d8da9a3ab0081d88623c1f725c77ff08fc4a5 (patch)
treebbeca672c40e18af22fcb37603551094b24bf388 /gcc
parentab7102895d7be931dcc69fedf8f56ace19438648 (diff)
downloadgcc-c23d8da9a3ab0081d88623c1f725c77ff08fc4a5.tar.gz
doc: @var fixes.
gcc/: * 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. git-svn-id: svn+ssh://gcc.gnu.org/svn/gcc/trunk@168081 138bc75d-0d04-0410-961f-82ee72b054a4
Diffstat (limited to 'gcc')
-rw-r--r--gcc/ChangeLog8
-rw-r--r--gcc/doc/cppopts.texi8
-rw-r--r--gcc/doc/extend.texi2
-rw-r--r--gcc/doc/gimple.texi4
-rw-r--r--gcc/doc/invoke.texi10
-rw-r--r--gcc/doc/plugins.texi12
6 files changed, 26 insertions, 18 deletions
diff --git a/gcc/ChangeLog b/gcc/ChangeLog
index 8224947c113..aaafb645b32 100644
--- a/gcc/ChangeLog
+++ b/gcc/ChangeLog
@@ -1,5 +1,13 @@
2010-12-20 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/install.texi (Configuration, Building, Testing, Specific):
Remove leading whitespace from examples.
diff --git a/gcc/doc/cppopts.texi b/gcc/doc/cppopts.texi
index 57624ed7497..5212478389d 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 cbfb44009e1..90f8b7afd39 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 5e217a772da..e8cecd75d3c 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 b28073c4523..834965131a4 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 5a560424993..767cee8800c 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