diff options
author | Thomas Preud'homme <thomas.preudhomme@arm.com> | 2018-07-02 11:18:24 +0100 |
---|---|---|
committer | Thomas Preud'homme <thomas.preudhomme@arm.com> | 2018-07-02 11:18:24 +0100 |
commit | a05a5b64cf33d36d93a92fd03ae900e18dbe5572 (patch) | |
tree | 15b75a1cf3c0fc782160e6e592c63d822e312e6e /gas/doc/c-arm.texi | |
parent | f2075844e2d4dc0f3f0d15b1acf20651f19cbb33 (diff) | |
download | gdb-a05a5b64cf33d36d93a92fd03ae900e18dbe5572.zip gdb-a05a5b64cf33d36d93a92fd03ae900e18dbe5572.tar.gz gdb-a05a5b64cf33d36d93a92fd03ae900e18dbe5572.tar.bz2 |
Fix use of "command line X" in binutils doc
Binutils documentation uses a mix of spelling for the compound word
"command-line X". According to [1]:
"Sometimes compound words are written separately (nail polish),
sometimes with a hyphen (short-sighted) and sometimes as one word
(eyelashes). Often new compounds are written as two separate words and,
as they become more familiar, they are either connected with a hyphen
(-) or made into one word."
I think command-line X is common enough in our industry that the two
workds command and line should be connected. Since command-line is more
common than commandline, I propose to update binutils documentation to
consistently use "command-line" when this is used as an adjective to a
noun (eg. command-line argument, command-line switch, command-line
option and command-line flag). I've left occurences of "the command
line" as is. I've also left gdb, sim and readline alone and have only
touched public documentation (texi and NEWS files).
[1]
http://dictionary.cambridge.org/grammar/british-grammar/word-formation/compounds
2018-07-02 Thomas Preud'homme <thomas.preudhomme@arm.com>
bfd/
* doc/bfdint.texi: Use command-line consistently when used in a
compount word.
* doc/bfdsumm.texi: Likewise.
binutils/
* NEWS: Use command-line consistently when used in a compount word.
* doc/binutils.texi: Likewise and fix trailing whitespace on same
line.
gas/
* NEWS: Use command-line consistently when used in a compount word.
* doc/as.texi: Likewise.
* doc/c-aarch64.texi: Likewise.
* doc/c-alpha.texi: Likewise.
* doc/c-arc.texi: Likewise.
* doc/c-arm.texi: Likewise.
* doc/c-avr.texi: Likewise.
* doc/c-bfin.texi: Likewise.
* doc/c-cris.texi: Likewise.
* doc/c-epiphany.texi: Likewise.
* doc/c-i386.texi: Likewise.
* doc/c-ia64.texi: Likewise.
* doc/c-lm32.texi: Likewise.
* doc/c-m32r.texi: Likewise.
* doc/c-m68k.texi: Likewise.
* doc/c-mips.texi: Likewise.
* doc/c-mmix.texi: Likewise.
* doc/c-msp430.texi: Likewise.
* doc/c-mt.texi: Likewise.
* doc/c-nios2.texi: Likewise.
* doc/c-ppc.texi: Likewise.
* doc/c-pru.texi: Likewise.
* doc/c-rl78.texi: Likewise.
* doc/c-rx.texi: Likewise.
* doc/c-tic6x.texi: Likewise.
* doc/c-v850.texi: Likewise.
* doc/c-vax.texi: Likewise.
* doc/c-visium.texi: Likewise.
* doc/c-xstormy16.texi: Likewise.
* doc/c-xtensa.texi: Likewise.
* doc/c-z80.texi: Likewise.
* doc/c-z8k.texi: Likewise.
* doc/internals.texi: Likewise.
gprof/
* gprof.texi: Use command-line consistently when used in a compount
word.
ld/
* NEWS: Use command-line consistently when used in a compount word.
* ld.texinfo: Likewise.
* ldint.texinfo: Likewise.
Diffstat (limited to 'gas/doc/c-arm.texi')
-rw-r--r-- | gas/doc/c-arm.texi | 48 |
1 files changed, 24 insertions, 24 deletions
diff --git a/gas/doc/c-arm.texi b/gas/doc/c-arm.texi index 4683b8a..d2f6fe1 100644 --- a/gas/doc/c-arm.texi +++ b/gas/doc/c-arm.texi @@ -32,7 +32,7 @@ @table @code -@cindex @code{-mcpu=} command line option, ARM +@cindex @code{-mcpu=} command-line option, ARM @item -mcpu=@var{processor}[+@var{extension}@dots{}] This option specifies the target processor. The assembler will issue an error message if an attempt is made to assemble an instruction which @@ -201,7 +201,7 @@ for v8-A architecture), and @code{xscale}. -@cindex @code{-march=} command line option, ARM +@cindex @code{-march=} command-line option, ARM @item -march=@var{architecture}[+@var{extension}@dots{}] This option specifies the target architecture. The assembler will issue an error message if an attempt is made to assemble an instruction which @@ -252,7 +252,7 @@ the setting for @code{-mcpu}. The architecture option can be extended with the same instruction set extension options as the @code{-mcpu} option. -@cindex @code{-mfpu=} command line option, ARM +@cindex @code{-mfpu=} command-line option, ARM @item -mfpu=@var{floating-point-format} This option specifies the floating point format to assemble for. The @@ -309,19 +309,19 @@ The default is dependent on the processor selected. For Architecture 5 or later, the default is to assemble for VFP instructions; for earlier architectures the default is to assemble for FPA instructions. -@cindex @code{-mthumb} command line option, ARM +@cindex @code{-mthumb} command-line option, ARM @item -mthumb This option specifies that the assembler should start assembling Thumb instructions; that is, it should behave as though the file starts with a @code{.code 16} directive. -@cindex @code{-mthumb-interwork} command line option, ARM +@cindex @code{-mthumb-interwork} command-line option, ARM @item -mthumb-interwork This option specifies that the output generated by the assembler should be marked as supporting interworking. It also affects the behaviour of the @code{ADR} and @code{ADRL} pseudo opcodes. -@cindex @code{-mimplicit-it} command line option, ARM +@cindex @code{-mimplicit-it} command-line option, ARM @item -mimplicit-it=never @itemx -mimplicit-it=always @itemx -mimplicit-it=arm @@ -339,15 +339,15 @@ If @code{thumb} is specified, such constructs cause a warning in ARM code and are accepted in Thumb-2 code. If you omit this option, the behavior is equivalent to @code{-mimplicit-it=arm}. -@cindex @code{-mapcs-26} command line option, ARM -@cindex @code{-mapcs-32} command line option, ARM +@cindex @code{-mapcs-26} command-line option, ARM +@cindex @code{-mapcs-32} command-line option, ARM @item -mapcs-26 @itemx -mapcs-32 These options specify that the output generated by the assembler should be marked as supporting the indicated version of the Arm Procedure. Calling Standard. -@cindex @code{-matpcs} command line option, ARM +@cindex @code{-matpcs} command-line option, ARM @item -matpcs This option specifies that the output generated by the assembler should be marked as supporting the Arm/Thumb Procedure Calling Standard. If @@ -355,18 +355,18 @@ enabled this option will cause the assembler to create an empty debugging section in the object file called .arm.atpcs. Debuggers can use this to determine the ABI being used by. -@cindex @code{-mapcs-float} command line option, ARM +@cindex @code{-mapcs-float} command-line option, ARM @item -mapcs-float This indicates the floating point variant of the APCS should be used. In this variant floating point arguments are passed in FP registers rather than integer registers. -@cindex @code{-mapcs-reentrant} command line option, ARM +@cindex @code{-mapcs-reentrant} command-line option, ARM @item -mapcs-reentrant This indicates that the reentrant variant of the APCS should be used. This variant supports position independent code. -@cindex @code{-mfloat-abi=} command line option, ARM +@cindex @code{-mfloat-abi=} command-line option, ARM @item -mfloat-abi=@var{abi} This option specifies that the output generated by the assembler should be marked as using specified floating point ABI. @@ -376,7 +376,7 @@ The following values are recognized: and @code{hard}. -@cindex @code{-eabi=} command line option, ARM +@cindex @code{-eabi=} command-line option, ARM @item -meabi=@var{ver} This option specifies which EABI version the produced object files should conform to. @@ -386,7 +386,7 @@ The following values are recognized: and @code{5}. -@cindex @code{-EB} command line option, ARM +@cindex @code{-EB} command-line option, ARM @item -EB This option specifies that the output generated by the assembler should be marked as being encoded for a big-endian processor. @@ -397,33 +397,33 @@ and little-endian instructions then it should be assembled with the the @option{--be8} option. This will reverse the endianness of the instructions back to little-endian, but leave the data as big-endian. -@cindex @code{-EL} command line option, ARM +@cindex @code{-EL} command-line option, ARM @item -EL This option specifies that the output generated by the assembler should be marked as being encoded for a little-endian processor. -@cindex @code{-k} command line option, ARM +@cindex @code{-k} command-line option, ARM @cindex PIC code generation for ARM @item -k This option specifies that the output of the assembler should be marked as position-independent code (PIC). -@cindex @code{--fix-v4bx} command line option, ARM +@cindex @code{--fix-v4bx} command-line option, ARM @item --fix-v4bx Allow @code{BX} instructions in ARMv4 code. This is intended for use with the linker option of the same name. -@cindex @code{-mwarn-deprecated} command line option, ARM +@cindex @code{-mwarn-deprecated} command-line option, ARM @item -mwarn-deprecated @itemx -mno-warn-deprecated Enable or disable warnings about using deprecated options or features. The default is to warn. -@cindex @code{-mccs} command line option, ARM +@cindex @code{-mccs} command-line option, ARM @item -mccs Turns on CodeComposer Studio assembly syntax compatibility mode. -@cindex @code{-mwarn-syms} command line option, ARM +@cindex @code{-mwarn-syms} command-line option, ARM @item -mwarn-syms @itemx -mno-warn-syms Enable or disable warnings about symbols that match the names of ARM @@ -624,7 +624,7 @@ boundary). This is for compatibility with ARM's own assembler. @cindex @code{.arch} directive, ARM @item .arch @var{name} Select the target architecture. Valid values for @var{name} are the same as -for the @option{-march} commandline option. +for the @option{-march} command-line option. Specifying @code{.arch} clears any previously selected architecture extensions. @@ -633,7 +633,7 @@ extensions. @item .arch_extension @var{name} Add or remove an architecture extension to the target architecture. Valid values for @var{name} are the same as those accepted as architectural -extensions by the @option{-mcpu} and @option{-march} commandline options. +extensions by the @option{-mcpu} and @option{-march} command-line options. @code{.arch_extension} may be used multiple times to add or remove extensions incrementally to the architecture being compiled for. @@ -663,7 +663,7 @@ selects Thumb, with the value 32 selecting ARM. @cindex @code{.cpu} directive, ARM @item .cpu @var{name} Select the target processor. Valid values for @var{name} are the same as -for the @option{-mcpu} commandline option. +for the @option{-mcpu} command-line option. Specifying @code{.cpu} clears any previously selected architecture extensions. @@ -771,7 +771,7 @@ target processor does not support those instructions @cindex @code{.fpu} directive, ARM @item .fpu @var{name} Select the floating-point unit to assemble for. Valid values for @var{name} -are the same as for the @option{-mfpu} commandline option. +are the same as for the @option{-mfpu} command-line option. @c GGGGGGGGGGGGGGGGGGGGGGGGGG @c HHHHHHHHHHHHHHHHHHHHHHHHHH |