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-mmix.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-mmix.texi')
-rw-r--r-- | gas/doc/c-mmix.texi | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/gas/doc/c-mmix.texi b/gas/doc/c-mmix.texi index 3ed6822..d10d750 100644 --- a/gas/doc/c-mmix.texi +++ b/gas/doc/c-mmix.texi @@ -27,25 +27,25 @@ @cindex MMIX options The MMIX version of @code{@value{AS}} has some machine-dependent options. -@cindex @samp{--fixed-special-register-names} command line option, MMIX +@cindex @samp{--fixed-special-register-names} command-line option, MMIX When @samp{--fixed-special-register-names} is specified, only the register names specified in @ref{MMIX-Regs} are recognized in the instructions @code{PUT} and @code{GET}. -@cindex @samp{--globalize-symbols} command line option, MMIX +@cindex @samp{--globalize-symbols} command-line option, MMIX You can use the @samp{--globalize-symbols} to make all symbols global. This option is useful when splitting up a @code{mmixal} program into several files. -@cindex @samp{--gnu-syntax} command line option, MMIX +@cindex @samp{--gnu-syntax} command-line option, MMIX The @samp{--gnu-syntax} turns off most syntax compatibility with @code{mmixal}. Its usability is currently doubtful. -@cindex @samp{--relax} command line option, MMIX +@cindex @samp{--relax} command-line option, MMIX The @samp{--relax} option is not fully supported, but will eventually make the object file prepared for linker relaxation. -@cindex @samp{--no-predefined-syms} command line option, MMIX +@cindex @samp{--no-predefined-syms} command-line option, MMIX If you want to avoid inadvertently calling a predefined symbol and would rather get an error, for example when using @code{@value{AS}} with a compiler or other machine-generated code, specify @@ -55,13 +55,13 @@ symbols, @samp{BIT} symbols, and @code{TRAP} symbols used in @code{mmix} ``system calls''. It also turns off predefined special-register names, except when used in @code{PUT} and @code{GET} instructions. -@cindex @samp{--no-expand} command line option, MMIX +@cindex @samp{--no-expand} command-line option, MMIX By default, some instructions are expanded to fit the size of the operand or an external symbol (@pxref{MMIX-Expand}). By passing @samp{--no-expand}, no such expansion will be done, instead causing errors at link time if the operand does not fit. -@cindex @samp{--no-merge-gregs} command line option, MMIX +@cindex @samp{--no-merge-gregs} command-line option, MMIX The @code{mmixal} documentation (@pxref{mmixsite}) specifies that global registers allocated with the @samp{GREG} directive (@pxref{MMIX-greg}) and initialized to the same non-zero value, will refer to the same global @@ -70,7 +70,7 @@ final addresses aren't known until link-time, but it will do an effort unless the @samp{--no-merge-gregs} option is specified. (Register merging isn't yet implemented in @code{@value{LD}}.) -@cindex @samp{-x} command line option, MMIX +@cindex @samp{-x} command-line option, MMIX @code{@value{AS}} will warn every time it expands an instruction to fit an operand unless the option @samp{-x} is specified. It is believed that this behaviour is more useful than just mimicking @code{mmixal}'s @@ -82,8 +82,8 @@ that at link stage can be contracted. (Though linker relaxation isn't yet implemented in @code{@value{LD}}.) The option @samp{-x} also implies @samp{--linker-allocated-gregs}. -@cindex @samp{--no-pushj-stubs} command line option, MMIX -@cindex @samp{--no-stubs} command line option, MMIX +@cindex @samp{--no-pushj-stubs} command-line option, MMIX +@cindex @samp{--no-stubs} command-line option, MMIX If instruction expansion is enabled, @code{@value{AS}} can expand a @samp{PUSHJ} instruction into a series of instructions. The shortest expansion is to not expand it, but just mark the call as redirectable to a @@ -97,7 +97,7 @@ then created at assembly-time. The option @samp{--no-stubs} is a synonym, intended for compatibility with future releases, where generation of stubs for other instructions may be implemented. -@cindex @samp{--linker-allocated-gregs} command line option, MMIX +@cindex @samp{--linker-allocated-gregs} command-line option, MMIX Usually a two-operand-expression (@pxref{GREG-base}) without a matching @samp{GREG} directive is treated as an error by @code{@value{AS}}. When the option @samp{--linker-allocated-gregs} is in effect, they are instead |