From 4ec7afd748c72bfdcc0aa684c90d6dda478b7a2b Mon Sep 17 00:00:00 2001
From: Kazu Hirata <kazu@cs.umass.edu>
Date: Fri, 17 Sep 2004 08:22:53 +0000
Subject: [PATCH] compat.texi, [...]: Use @option around options.
* doc/compat.texi, doc/cpp.texi, doc/cppopts.texi,
doc/extend.texi, doc/install.texi, doc/invoke.texi,
doc/sourcebuild.texi, doc/tm.texi, doc/tree-ssa.texi,
doc/trouble.texi: Use @option around options.
From-SVN: r87635
---
gcc/ChangeLog | 7 ++++++
gcc/doc/compat.texi | 2 +-
gcc/doc/cpp.texi | 2 +-
gcc/doc/cppopts.texi | 2 +-
gcc/doc/extend.texi | 2 +-
gcc/doc/install.texi | 2 +-
gcc/doc/invoke.texi | 47 ++++++++++++++++++++--------------------
gcc/doc/sourcebuild.texi | 10 ++++-----
gcc/doc/tm.texi | 8 +++----
gcc/doc/tree-ssa.texi | 2 +-
gcc/doc/trouble.texi | 4 ++--
11 files changed, 48 insertions(+), 40 deletions(-)
diff --git a/gcc/ChangeLog b/gcc/ChangeLog
index 9aa5ef08526f..64ffb4ebfd27 100644
--- a/gcc/ChangeLog
+++ b/gcc/ChangeLog
@@ -1,3 +1,10 @@
+2004-09-17 Kazu Hirata <kazu@cs.umass.edu>
+
+ * doc/compat.texi, doc/cpp.texi, doc/cppopts.texi,
+ doc/extend.texi, doc/install.texi, doc/invoke.texi,
+ doc/sourcebuild.texi, doc/tm.texi, doc/tree-ssa.texi,
+ doc/trouble.texi: Use @option around options.
+
2004-09-17 Richard Sandiford <rsandifo@redhat.com>
* Makefile.in (gen-protos.o): Depend on errors.h.
diff --git a/gcc/doc/compat.texi b/gcc/doc/compat.texi
index 5b02ebcac710..4e65b4582bd1 100644
--- a/gcc/doc/compat.texi
+++ b/gcc/doc/compat.texi
@@ -111,7 +111,7 @@ future GCC releases, but it is possible that we will encounter problems
that make this difficult. Such problems could include different
interpretations of the C++ ABI by different vendors, bugs in the ABI, or
bugs in the implementation of the ABI in different compilers.
-GCC's @code{-Wabi} switch warns when G++ generates code that is
+GCC's @option{-Wabi} switch warns when G++ generates code that is
probably not compatible with the C++ ABI@.
The C++ library used with a C++ compiler includes the Standard C++
diff --git a/gcc/doc/cpp.texi b/gcc/doc/cpp.texi
index c047c570f71b..d3e7c9e956c3 100644
--- a/gcc/doc/cpp.texi
+++ b/gcc/doc/cpp.texi
@@ -3760,7 +3760,7 @@ execution character set.
Currently, CPP requires its input to be ASCII or UTF-8. The execution
character set may be controlled by the user, with the
-@code{-ftarget-charset} and @code{-ftarget-wide-charset} options.
+@option{-ftarget-charset} and @option{-ftarget-wide-charset} options.
@item Identifier characters.
@anchor{Identifier characters}
diff --git a/gcc/doc/cppopts.texi b/gcc/doc/cppopts.texi
index a6b7eb44fbb4..e98f8d8e947c 100644
--- a/gcc/doc/cppopts.texi
+++ b/gcc/doc/cppopts.texi
@@ -332,7 +332,7 @@ 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
-@code{-fpreprocessed} is in use, GCC recognizes this @code{#pragma} and
+@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
diff --git a/gcc/doc/extend.texi b/gcc/doc/extend.texi
index ccab95a19af3..6b70565b3253 100644
--- a/gcc/doc/extend.texi
+++ b/gcc/doc/extend.texi
@@ -2903,7 +2903,7 @@ The @code{shared} attribute is only available on Microsoft Windows@.
@cindex @code{tls_model} attribute
The @code{tls_model} attribute sets thread-local storage model
(@pxref{Thread-Local}) of a particular @code{__thread} variable,
-overriding @code{-ftls-model=} command line switch on a per-variable
+overriding @option{-ftls-model=} command line switch on a per-variable
basis.
The @var{tls_model} argument should be one of @code{global-dynamic},
@code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
diff --git a/gcc/doc/install.texi b/gcc/doc/install.texi
index ec16b2143e39..d2d3e3bcee36 100644
--- a/gcc/doc/install.texi
+++ b/gcc/doc/install.texi
@@ -1501,7 +1501,7 @@ bootstrap4} to increase the number of stages of bootstrap.
Note that using non-standard @code{CFLAGS} can cause bootstrap to fail in
@file{libiberty}, if these trigger a warning with the new compiler. For
example using @samp{-O2 -g -mcpu=i686} on @code{i686-pc-linux-gnu} will
-cause bootstrap failure as @code{-mcpu=} is deprecated in 3.4.0 and above.
+cause bootstrap failure as @option{-mcpu=} is deprecated in 3.4.0 and above.
If you used the flag @option{--enable-languages=@dots{}} to restrict
diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
index e9f9cdedd2ea..d508c609cf10 100644
--- a/gcc/doc/invoke.texi
+++ b/gcc/doc/invoke.texi
@@ -1502,7 +1502,7 @@ it can cause bloating through duplication of code within each DSO where
it is used, often the wastage is less than the considerable space occupied
by a long symbol name in the export table which is typical when using
templates and namespaces. For even more savings, combine with the
-@code{-fvisibility=hidden} switch.
+@option{-fvisibility=hidden} switch.
@item -fno-weak
@opindex fno-weak
@@ -1982,7 +1982,7 @@ If a class is declared to implement a protocol, a warning is issued for
every method in the protocol that is not implemented by the class. The
default behavior is to issue a warning for every method not explicitly
implemented in the class, even if a method implementation is inherited
-from the superclass. If you use the @code{-Wno-protocol} option, then
+from the superclass. If you use the @option{-Wno-protocol} option, then
methods inherited from the superclass are considered to be implemented,
and no warning is issued for them.
@@ -1996,7 +1996,7 @@ expression, and a corresponding method for that selector has been found
during compilation. Because these checks scan the method table only at
the end of compilation, these warnings are not produced if the final
stage of compilation is not reached, for example because an error is
-found during compilation, or because the @code{-fsyntax-only} option is
+found during compilation, or because the @option{-fsyntax-only} option is
being used.
@item -Wundeclared-selector
@@ -2008,7 +2008,7 @@ method with that name has been declared before the
@code{@@interface} or @code{@@protocol} declaration, or implicitly in
an @code{@@implementation} section. This option always performs its
checks as soon as a @code{@@selector(@dots{})} expression is found,
-while @code{-Wselector} only performs its checks in the final stage of
+while @option{-Wselector} only performs its checks in the final stage of
compilation. This also enforces the coding style convention
that methods and selectors must be declared before being used.
@@ -4572,8 +4572,8 @@ size of superblocks using tracer pass. See @option{-ftracer} for details on
trace formation.
This mode should produce faster but significantly longer programs. Also
-without @code{-fbranch-probabilities} the traces constructed may not match the
-reality and hurt the performance. This only makes
+without @option{-fbranch-probabilities} the traces constructed may not
+match the reality and hurt the performance. This only makes
sense when scheduling after register allocation, i.e.@: with
@option{-fschedule-insns2} or at @option{-O2} or higher.
@@ -4597,36 +4597,36 @@ Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
@item -ftree-pre
Perform Partial Redundancy Elimination (PRE) on trees. This flag is
-enabled by default at -O and higher.
+enabled by default at @option{-O} and higher.
@item -ftree-fre
Perform Full Redundancy Elimination (FRE) on trees. The difference
between FRE and PRE is that FRE only considers expressions
that are computed on all paths leading to the redundant computation.
This analysis faster than PRE, though it exposes fewer redundancies.
-This flag is enabled by default at -O and higher.
+This flag is enabled by default at @option{-O} and higher.
@item -ftree-ccp
Perform sparse conditional constant propagation (CCP) on trees. This flag
-is enabled by default at -O and higher.
+is enabled by default at @option{-O} and higher.
@item -ftree-dce
Perform dead code elimination (DCE) on trees. This flag is enabled by
-default at -O and higher.
+default at @option{-O} and higher.
@item -ftree-dominator-opts
Perform dead code elimination (DCE) on trees. This flag is enabled by
-default at -O and higher.
+default at @option{-O} and higher.
@item -ftree-ch
Perform loop header copying on trees. This is beneficial since it increases
effectiveness of code motion optimizations. It also saves one jump. This flag
-is enabled by default at -O and higher. It is not enabled for -Os, since it
-usually increases code size.
+is enabled by default at @option{-O} and higher. It is not enabled
+for @option{-Os}, since it usually increases code size.
@item -ftree-loop-optimize
-Perform loop optimizations on trees. This flag is enabled by default at -O
-and higher.
+Perform loop optimizations on trees. This flag is enabled by default
+at @option{-O} and higher.
@item -ftree-loop-linear
Perform linear loop transformations on tree. This flag can improve cache
@@ -4653,25 +4653,25 @@ variable merging and induction variable elimination) on trees.
@item -ftree-sra
Perform scalar replacement of aggregates. This pass replaces structure
references with scalars to prevent committing structures to memory too
-early. This flag is enabled by default at -O and higher.
+early. This flag is enabled by default at @option{-O} and higher.
@item -ftree-copyrename
Perform copy renaming on trees. This pass attempts to rename compiler
temporaries to other variables at copy locations, usually resulting in
variable names which more closely resemble the original variables. This flag
-is enabled by default at -O and higher.
+is enabled by default at @option{-O} and higher.
@item -ftree-ter
Perform temporary expression replacement during the SSA->normal phase. Single
use/single def temporaries are replaced at their use location with their
defining expression. This results in non-GIMPLE code, but gives the expanders
much more complex trees to work on resulting in better RTL generation. This is
-enabled by default at -O and higher.
+enabled by default at @option{-O} and higher.
@item -ftree-lrs
Perform live range splitting during the SSA->normal phase. Distinct live
ranges of a variable are split into unique variables, allowing for better
-optimization later. This is enabled by default at -O and higher.
+optimization later. This is enabled by default at @option{-O} and higher.
@item -ftree-vectorize
Perform loop vectorization on trees.
@@ -4966,7 +4966,7 @@ Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
Enable options usually used for instrumenting application to produce
profile useful for later recompilation with profile feedback based
-optimization. You must use @code{-fprofile-generate} both when
+optimization. You must use @option{-fprofile-generate} both when
compiling and when linking your program.
The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
@@ -8011,7 +8011,7 @@ Generate code for the H8S@.
@item -mn
@opindex mn
Generate code for the H8S and H8/300H in the normal mode. This switch
-must be used either with -mh or -ms.
+must be used either with @option{-mh} or @option{-ms}.
@item -ms2600
@opindex ms2600
@@ -9105,7 +9105,8 @@ the system.
@item -msep-data
Generate code that allows the data segment to be located in a different
area of memory from the text segment. This allows for execute in place in
-an environment without virtual memory management. This option implies -fPIC.
+an environment without virtual memory management. This option implies
+@option{-fPIC}.
@item -mno-sep-data
Generate code that assumes that the data segment follows the text segment.
@@ -9114,7 +9115,7 @@ This is the default.
@item -mid-shared-library
Generate code that supports shared libraries via the library ID method.
This allows for execute in place and shared libraries in an environment
-without virtual memory management. This option implies -fPIC.
+without virtual memory management. This option implies @option{-fPIC}.
@item -mno-id-shared-library
Generate code that doesn't assume ID based shared libraries are being used.
diff --git a/gcc/doc/sourcebuild.texi b/gcc/doc/sourcebuild.texi
index 172ffd1a36ee..8314bf65b50d 100644
--- a/gcc/doc/sourcebuild.texi
+++ b/gcc/doc/sourcebuild.texi
@@ -1084,7 +1084,7 @@ Commands to check line counts are processed by default.
Commands to check branch percentages and call return percentages are
processed if the @command{run-gcov} command has arguments @code{branches}
or @code{calls}, respectively. For example, the following specifies
-checking both, as well as passing @code{-b} to @command{gcov}:
+checking both, as well as passing @option{-b} to @command{gcov}:
@smallexample
@{ dg-final @{ run-gcov branches calls @{ -b sourcefile @} @} @}
@@ -1216,10 +1216,10 @@ where @var{tsti} and @var{alti} are lists of options, with @var{tsti}
used by the compiler under test and @var{alti} used by the alternate
compiler. For example, with
@code{[list [list @{-g -O0@} @{-O3@}] [list @{-fpic@} @{-fPIC -O2@}]]},
-the test is first built with @code{-g -O0} by the compiler under
-test and with @code{-O3} by the alternate compiler. The test is
-built a second time using @code{-fpic} by the compiler under test
-and @code{-fPIC -O2} by the alternate compiler.
+the test is first built with @option{-g -O0} by the compiler under
+test and with @option{-O3} by the alternate compiler. The test is
+built a second time using @option{-fpic} by the compiler under test
+and @option{-fPIC -O2} by the alternate compiler.
An alternate compiler is specified by defining an environment
variable to be the full pathname of an installed compiler; for C
diff --git a/gcc/doc/tm.texi b/gcc/doc/tm.texi
index f0132e01f540..5d777c48229f 100644
--- a/gcc/doc/tm.texi
+++ b/gcc/doc/tm.texi
@@ -154,8 +154,8 @@ are valid. Replacement options may not be the @code{--opt} style, they
must be the @code{-opt} style. It is the intention of this macro to
provide a mechanism for substitution that affects the multilibs chosen,
such as one option that enables many options, some of which select
-multilibs. Example nonsensical definition, where @code{-malt-abi},
-@code{-EB}, and @code{-mspoo} cause different multilibs to be chosen:
+multilibs. Example nonsensical definition, where @option{-malt-abi},
+@option{-EB}, and @option{-mspoo} cause different multilibs to be chosen:
@smallexample
#define TARGET_OPTION_TRANSLATE_TABLE \
@@ -298,8 +298,8 @@ passes the string @option{-lgcc} to the linker.
By default, if @code{ENABLE_SHARED_LIBGCC} is defined, the
@code{LIBGCC_SPEC} is not directly used by the driver program but is
instead modified to refer to different versions of @file{libgcc.a}
-depending on the values of the command line flags @code{-static},
-@code{-shared}, @code{-static-libgcc}, and @code{-shared-libgcc}. On
+depending on the values of the command line flags @option{-static},
+@option{-shared}, @option{-static-libgcc}, and @option{-shared-libgcc}. On
targets where these modifications are inappropriate, define
@code{REAL_LIBGCC_SPEC} instead. @code{REAL_LIBGCC_SPEC} tells the
driver how to place a reference to @file{libgcc} on the link command
diff --git a/gcc/doc/tree-ssa.texi b/gcc/doc/tree-ssa.texi
index 6d03f504df7e..f4c981f3e288 100644
--- a/gcc/doc/tree-ssa.texi
+++ b/gcc/doc/tree-ssa.texi
@@ -152,7 +152,7 @@ a definition of @code{LANG_HOOKS_GIMPLIFY_EXPR}, call
@code{tree_rest_of_compilation} to compile and output the function.
You can tell the compiler to dump a C-like representation of the GIMPLE
-form with the flag @code{-fdump-tree-gimple}.
+form with the flag @option{-fdump-tree-gimple}.
@node Temporaries
@subsection Temporaries
diff --git a/gcc/doc/trouble.texi b/gcc/doc/trouble.texi
index a546183737cd..8ce6afc01ee2 100644
--- a/gcc/doc/trouble.texi
+++ b/gcc/doc/trouble.texi
@@ -998,11 +998,11 @@ compiler will consequently produce the following error message:
@end smallexample
To make the code valid either use @code{this->f()}, or
-@code{Base<T>::f()}. Using the @code{-fpermissive} flag will also let
+@code{Base<T>::f()}. Using the @option{-fpermissive} flag will also let
the compiler accept the code, by marking all function calls for which no
declaration is visible at the time of definition of the template for
later lookup at instantiation time, as if it were a dependent call.
-We do not recommend using @code{-fpermissive} to work around invalid
+We do not recommend using @option{-fpermissive} to work around invalid
code, and it will also only catch cases where functions in base classes
are called, not where variables in base classes are used (as in the
example above).
--
GitLab