]> git.ipfire.org Git - thirdparty/gcc.git/commitdiff
doc: Spell "command-line option" with a dash
authorGerald Pfeifer <gerald@pfeifer.com>
Mon, 8 Jun 2026 20:08:41 +0000 (22:08 +0200)
committerGerald Pfeifer <gerald@pfeifer.com>
Mon, 8 Jun 2026 20:08:41 +0000 (22:08 +0200)
On the way fix some grammar issues and consistently use "option"
over "flag" or "switch".

gcc:
* doc/cpp.texi: Spell "command-line option" with a dash.
(Binary Resource Inclusion): Ditto.
* doc/fragments.texi (Target Fragment): Ditto.
* doc/gcc.texi: Ditto.
(Indices): Ditto.
* doc/gccint.texi: Ditto.
(Top): Ditto.
(Option Index): Ditto.
* doc/gcov.texi (Invoking Gcov): Ditto. And fix grammar.
* doc/gm2.texi (Compiler options): Ditto.
(Extensions): Ditto.
(The PIM system module): Ditto.
(The ISO system module): Ditto.
* doc/invoke.texi (Debugging Options): Ditto.
(AVR Options): Ditto.
* doc/lto.texi (LTO object file layout): Ditto.
(WHOPR): Ditto.
* doc/md.texi (Machine Constraints): Ditto.
* doc/objc.texi (Constant string objects): Ditto. And fix grammar.
(Exceptions): Ditto.
(Synchronization): Ditto.

* doc/tm.texi.in: Ditto. And standardize on "option" over
"flag".
(strategy): Ditto. And standardize on "option" over "switch"
and fix grammar.
* target.def: Ditto.
* doc/tm.texi: Regenerate.

13 files changed:
gcc/doc/cpp.texi
gcc/doc/fragments.texi
gcc/doc/gcc.texi
gcc/doc/gccint.texi
gcc/doc/gcov.texi
gcc/doc/gm2.texi
gcc/doc/invoke.texi
gcc/doc/lto.texi
gcc/doc/md.texi
gcc/doc/objc.texi
gcc/doc/tm.texi
gcc/doc/tm.texi.in
gcc/target.def

index 69a74617a0fce9358a98e862d9a15fc787ce0006..332ee01a60567bfe5b6650dba83938d017be26fd 100644 (file)
@@ -40,7 +40,7 @@ This manual contains no Invariant Sections.  The Front-Cover Texts are
 @c man end
 @end copying
 
-@c Create a separate index for command line options.
+@c Create a separate index for command-line options.
 @defcodeindex op
 @syncodeindex vr op
 
@@ -3951,13 +3951,13 @@ as @samp{#include}.
 @item #embed <@var{file}>
 If @var{file} is an absolute filename, this includes the mentioned
 file, otherwise searches it in directories specified by the
-@option{--embed-dir=} command line option for the @var{file}.
+@option{--embed-dir=} command-line option for the @var{file}.
 
 @item #embed "@var{file}"
 This variant searches @var{file} in the same directory as the source
 file which uses the @code{#embed} directive and only if not found there
 continues searching directories specified by the @option{--embed-dir=}
-command line option.
+command-line option.
 @end table
 
 The @code{#embed} directive is expanded as if it was a sequence of
index f4f019cc0af8f63d86396172939cf27110150b95..82a982cd51e3eb9c0765fc5ccd9c67963158bb7e 100644 (file)
@@ -68,7 +68,7 @@ produces both big and little endian code.  For these targets, you must
 arrange for multiple versions of @file{libgcc.a} to be compiled, one for
 each set of incompatible options.  When GCC invokes the linker, it
 arranges to link in the right version of @file{libgcc.a}, based on
-the command line options used.
+the command-line options used.
 
 The @code{MULTILIB_OPTIONS} macro lists the set of options for which
 special versions of @file{libgcc.a} must be built.  Write options that
index 495f09bc9d3ec73daec1ebd3f32a5412c5fde34a..b9af262f044ed5863a72a4437977a0fffa055c14 100644 (file)
@@ -26,7 +26,7 @@
 
 @settitle Using the GNU Compiler Collection (GCC)
 
-@c Create a separate index for command line options.
+@c Create a separate index for command-line options.
 @defcodeindex op
 @c Likewise create a separate index for attributes.
 @defindex at
@@ -208,7 +208,7 @@ object files.
 @appendix Indices
 
 @menu
-* Option Index::                Index to command line options.
+* Option Index::                Index of command-line options.
 * Attribute Index::             Index of GNU extension attributes.
 * Concept and Symbol Index::    Index of concepts and symbol names.
 @end menu
index 3f248c59428450b459a2953b589796d3e2122f9d..3ab48c8ee3eeed1c3aee376ff3e918c77c31daa2 100644 (file)
@@ -12,7 +12,7 @@
 
 @settitle GNU Compiler Collection (GCC) Internals
 
-@c Create a separate index for command line options.
+@c Create a separate index for command-line options.
 @defcodeindex op
 
 @c Likewise for parameters.
@@ -143,7 +143,7 @@ Additional tutorial information is linked to from
 * GNU Free Documentation License:: How you can copy and share this manual.
 * Contributors::    People who have contributed to GCC.
 
-* Option Index::    Index to command line options.
+* Option Index::    Index to command-line options.
 * Parameter Index:: Index to parameters settable from the command line.
 * Concept Index::   Index of concepts and symbol names.
 * Named Pattern Index:: Index of standard pattern names.
@@ -198,7 +198,7 @@ Additional tutorial information is linked to from
 @node Option Index
 @unnumbered Option Index
 
-GCC's command line options are indexed here without any initial @samp{-}
+GCC's command-line options are indexed here without any initial @samp{-}
 or @samp{--}.  Where an option has both positive and negative forms
 (such as @option{-f@var{option}} and @option{-fno-@var{option}}),
 relevant entries in the manual are indexed under the most appropriate
index 52239d2437aecdc546f93d8f2b94647048be4739..a5fed102026a056a1b3521919f7c129b026cfd6a 100644 (file)
@@ -665,7 +665,7 @@ program source code.  The format is
 @end smallexample
 
 Additional block information may succeed each line, when requested by
-command line option.  The @var{execution_count} is @samp{-} for lines
+a command-line option.  The @var{execution_count} is @samp{-} for lines
 containing no code.  Unexecuted lines are marked @samp{#####} or
 @samp{=====}, depending on whether they are reachable by
 non-exceptional paths or only exceptional paths such as C++ exception
index 2991b2b05d1529e1dbe8f45019cc98139d98e825..6e14ffe64d3fd0ac9b3fbc5f8ba48bb7ecea601f 100644 (file)
@@ -408,7 +408,7 @@ default if a requested definition module is not found.
 
 @item -fdump-system-exports
 display all inbuilt system items.
-This is an internal command line option.
+This is an internal command-line option.
 
 @item -fexceptions
 turn on exception handling code.  By default this option is on.
@@ -466,7 +466,7 @@ this option forces the use of the static version.
 
 @item -fm2-debug-trace=
 turn on trace debugging using a comma separated list:
-@samp{line,token,quad,all}.  This is an internal command line option.
+@samp{line,token,quad,all}.  This is an internal command-line option.
 
 @item -fm2-dump=
 enable dumping of modula-2 internal representation of data structures
@@ -1738,7 +1738,7 @@ anywhere   __COLUMN__               Gives a constant literal number
 @end example
 
 The preprocessor @samp{cpp} can be invoked via the @samp{-fcpp}
-command line option.  This in turn invokes @samp{cpp} with the
+command-line option.  This in turn invokes @samp{cpp} with the
 following arguments @samp{-traditional -lang-asm}.  These options
 preserve comments and all quotations.  @samp{gm2} treats a @samp{#}
 character in the first column as a preprocessor directive unless
@@ -3239,7 +3239,7 @@ is unsigned and is mapped onto the target C data type @code{size_t}
 whereas the type @code{CSSIZE_T} is mapped onto the signed C data type
 @code{ssize_t}.  The default size for the signed type @code{COFF_T} is
 the same as @code{CSSIZE_T} and this can be overridden by the
-@code{-fm2-file-offset-bits=} command line option.
+@code{-fm2-file-offset-bits=} command-line option.
 
 It is anticipated that these should only be used to provide cross
 platform definition modules for C libraries.
@@ -3259,7 +3259,7 @@ is unsigned and is mapped onto the target C data type @code{size_t}
 whereas the type @code{CSSIZE_T} is mapped onto the signed C data type
 @code{ssize_t}.  The default size for the signed type @code{COFF_T} is
 the same as @code{CSSIZE_T} and this can be overridden by the
-@code{-fm2-file-offset-bits=} command line option.
+@code{-fm2-file-offset-bits=} command-line option.
 
 It is anticipated that these should only be used to provide cross
 platform definition modules for C libraries.
index 339d1d2c97a2174a9ea16f4ca8f47a4de2ac43ae..9a753749870cbe50462eab83a0d0cbc8c708d6dd 100644 (file)
@@ -12906,7 +12906,7 @@ Emit custom warnings with internal details intended for analyzer developers.
 To tell GCC to emit extra information for use by a debugger, in almost
 all cases you need only to add @option{-g} to your other options.  Some debug
 formats can co-exist (like DWARF with CTF) when each of them is enabled
-explicitly by adding the respective command line option to your other options.
+explicitly by adding the respective command-line option to your other options.
 
 GCC allows you to use @option{-g} with
 @option{-O}.  The shortcuts taken by optimized code may occasionally
@@ -12972,7 +12972,7 @@ in their names, but apply to all currently-supported versions of DWARF.
 Request BTF debug information.  BTF is the default debugging format for the
 eBPF target.  On other targets, like x86, BTF debug information can be
 generated along with DWARF debug information when both of the debug formats are
-enabled explicitly via their respective command line options.
+enabled explicitly via their respective command-line options.
 
 @opindex gprune-btf
 @opindex gno-prune-btf
@@ -24434,7 +24434,7 @@ to set up FLMAP according to symbol @code{__flmap}.
 @item -nodevicespecs
 Don't add @option{-specs=device-specs/specs-@var{mcu}} to the compiler driver's
 command line.  The user takes responsibility for supplying the sub-processes
-like compiler proper, assembler and linker with appropriate command line
+like compiler proper, assembler and linker with appropriate command-line
 options.  This means that the user has to supply her private device specs
 file by means of @option{-specs=@var{path-to-specs-file}}.  There is no
 more need for option @option{-mmcu=@var{mcu}}.
@@ -24898,7 +24898,7 @@ to be subtracted from the RAM address in order to get the
 respective I/O@tie{}address.
 
 @item __AVR_SHORT_CALLS__
-The @option{-mshort-calls} command line option is set.
+The @option{-mshort-calls} command-line option is set.
 
 @item __AVR_PM_BASE_ADDRESS__=@var{addr}
 Some devices support reading from flash memory by means of @code{LD*}
index c8da13d3beff103301aeb12cf5e131205d1119c0..ed3180f38c01293d44852f2aa9d4afd5e9eb5f28 100644 (file)
@@ -163,9 +163,9 @@ individual functions dealing with the reading/writing of each section
 are described below.
 
 @itemize @bullet
-@item Command line options (@code{.gnu.lto_.opts})
+@item Command-line options (@code{.gnu.lto_.opts})
 
-This section contains the command line options used to generate the
+This section contains the command-line options used to generate the
 object files.  This is used at link time to determine the optimization
 level and other settings when they are not explicitly specified at the
 linker command line.
@@ -514,7 +514,7 @@ initializers cannot be overwritten by a different value.
 GCC provides the function and variable attribute
 @code{visibility} that can be used to specify the visibility of
 externally visible symbols (or alternatively an
-@option{-fdefault-visibility} command line option).  ELF defines
+@option{-fdefault-visibility} command-line option).  ELF defines
 the @code{default}, @code{protected}, @code{hidden} and
 @code{internal} visibilities.
 
index 5d6dec1d7a500db0382fc56650a393edd50203e9..90755bdf389a2ae514c43d2c2f8848a69acc1215 100644 (file)
@@ -2182,7 +2182,7 @@ VFP floating-point registers @code{s0}-@code{s31}.  Used for 32 bit values.
 
 @item w
 VFP floating-point registers @code{d0}-@code{d31} and the appropriate
-subset @code{d0}-@code{d15} based on command line options.
+subset @code{d0}-@code{d15} based on command-line options.
 Used for 64 bit values only.  Not valid for Thumb1.
 
 @item G
index b87f9db480a6d8249f896ed06885d9b908aec710..dc8414518fae715d5256d9f7ba3ca027178fd7df 100644 (file)
@@ -677,7 +677,7 @@ runtime.  To get the definition of this class you must include the
 
 User defined libraries may want to implement their own constant string
 class.  To be able to support them, the GNU Objective-C compiler provides
-a new command line options @option{-fconstant-string-class=@var{class-name}}.
+a new command-line option @option{-fconstant-string-class=@var{class-name}}.
 The provided class should adhere to a strict structure, the same
 as @code{NXConstantString}'s structure:
 
@@ -800,7 +800,7 @@ There are several caveats to using the new exception mechanism:
 
 @itemize @bullet
 @item
-The @option{-fobjc-exceptions} command line option must be used when
+The @option{-fobjc-exceptions} command-line option must be used when
 compiling Objective-C files that use exceptions.
 
 @item
@@ -852,7 +852,7 @@ object to be unlocked properly.
 
 Because of the interactions between synchronization and exception
 handling, you can only use @code{@@synchronized} when compiling with
-exceptions enabled, that is with the command line option
+exceptions enabled, that is with the command-line option
 @option{-fobjc-exceptions}.
 
 
index d1e5d1b79521d5236db97292348e3ba9b144e6dc..260209e279e560a66266739e578156bc06eb5584 100644 (file)
@@ -293,7 +293,7 @@ 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 @option{-static},
+depending on the values of the command-line options @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
@@ -658,7 +658,7 @@ built-in preprocessor macros and assertions for the target CPU, using
 the functions @code{builtin_define}, @code{builtin_define_std} and
 @code{builtin_assert}.  When the front end
 calls this macro it provides a trailing semicolon, and since it has
-finished command line option processing your code can use those
+finished command-line option processing your code can use those
 results freely.
 
 @code{builtin_assert} takes a string in the form you pass to the
@@ -6000,8 +6000,8 @@ If the macro is set to 0, the "GNU" Objective-C message sending convention
 will be used by default.  This convention passes just the object and the
 selector to the method-lookup function, which returns a pointer to the method.
 
-In either case, it remains possible to select code-generation for the alternate
-scheme, by means of compiler command line switches.
+In either case, it remains possible to select code-generation for the
+alternate scheme by means of compiler command-line options.
 @end defmac
 
 @node Addressing Modes
index 6c9c4658b9d9cad92403c0ba554637af303e21b8..0944563c9cba89a8ce8993b1a1ff871e54036bcc 100644 (file)
@@ -293,7 +293,7 @@ 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 @option{-static},
+depending on the values of the command-line options @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
@@ -653,7 +653,7 @@ built-in preprocessor macros and assertions for the target CPU, using
 the functions @code{builtin_define}, @code{builtin_define_std} and
 @code{builtin_assert}.  When the front end
 calls this macro it provides a trailing semicolon, and since it has
-finished command line option processing your code can use those
+finished command-line option processing your code can use those
 results freely.
 
 @code{builtin_assert} takes a string in the form you pass to the
@@ -4151,8 +4151,8 @@ If the macro is set to 0, the "GNU" Objective-C message sending convention
 will be used by default.  This convention passes just the object and the
 selector to the method-lookup function, which returns a pointer to the method.
 
-In either case, it remains possible to select code-generation for the alternate
-scheme, by means of compiler command line switches.
+In either case, it remains possible to select code-generation for the
+alternate scheme by means of compiler command-line options.
 @end defmac
 
 @node Addressing Modes
index 6ade66716a3bb671174613ecbf34cc35b1277b73..89788a26986c8581523fb2ca43ba79d7059fdecc 100644 (file)
@@ -3547,7 +3547,7 @@ The result is the value to be used with @code{DW_AT_address_class}.",
 DEFHOOK
 (diagnose_usage,
  "Define this hook if the availability of an address space depends on\n\
-command line options and some diagnostics should be printed when the\n\
+command-line options and some diagnostics should be printed when the\n\
 address space is used.  This hook is called during parsing and allows\n\
 to emit a better diagnostic compared to the case where the address space\n\
 was not registered with @code{c_register_addr_space}.  @var{as} is\n\