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-mips.texi | |
parent | f2075844e2d4dc0f3f0d15b1acf20651f19cbb33 (diff) | |
download | fsf-binutils-gdb-a05a5b64cf33d36d93a92fd03ae900e18dbe5572.zip fsf-binutils-gdb-a05a5b64cf33d36d93a92fd03ae900e18dbe5572.tar.gz fsf-binutils-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-mips.texi')
-rw-r--r-- | gas/doc/c-mips.texi | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/gas/doc/c-mips.texi b/gas/doc/c-mips.texi index 9cbfaf2..24f6843 100644 --- a/gas/doc/c-mips.texi +++ b/gas/doc/c-mips.texi @@ -522,7 +522,7 @@ for branches. By default @samp{-mno-ignore-branch-isa} is selected, causing any invalid branch requiring a transition between ISA modes to produce an error. -@cindex @option{-mnan=} command line option, MIPS +@cindex @option{-mnan=} command-line option, MIPS @item -mnan=@var{encoding} This option indicates whether the source code uses the IEEE 2008 NaN encoding (@option{-mnan=2008}) or the original MIPS encoding @@ -748,7 +748,7 @@ for the corresponding ISA level, from that point on in the assembly. @code{.set mips@var{n}} affects not only which instructions are permitted, but also how certain macros are expanded. @code{.set mips0} restores the ISA level to its original level: either the -level you selected with command line options, or the default for your +level you selected with command-line options, or the default for your configuration. You can use this feature to permit specific MIPS III instructions while assembling in 32 bit mode. Use this directive with care! @@ -758,7 +758,7 @@ care! The @code{.set arch=@var{cpu}} directive provides even finer control. It changes the effective CPU target and allows the assembler to use instructions specific to a particular CPU. All CPUs supported by the -@samp{-march} command line option are also selectable by this directive. +@samp{-march} command-line option are also selectable by this directive. The original value is restored by @code{.set arch=default}. The directive @code{.set mips16} puts the assembler into MIPS 16 mode, @@ -776,13 +776,13 @@ Traditional MIPS assemblers do not support this directive. @node MIPS assembly options @section Directives to control code generation -@cindex MIPS directives to override command line options +@cindex MIPS directives to override command-line options @kindex @code{.module} -The @code{.module} directive allows command line options to be set directly +The @code{.module} directive allows command-line options to be set directly from assembly. The format of the directive matches the @code{.set} directive but only those options which are relevant to a whole module are supported. The effect of a @code{.module} directive is the same as the -corresponding command line option. Where @code{.set} directives support +corresponding command-line option. Where @code{.set} directives support returning to a default then the @code{.module} directives do not as they define the defaults. @@ -873,7 +873,7 @@ other and must be tracked carefully. Traditionally the use of an explicit @code{.gnu_attribute 4, @var{n}} directive is used to indicate which ABI is in use by a specific module. -It was then left to the user to ensure that command line options and the +It was then left to the user to ensure that command-line options and the selected ABI were compatible with some potential for inconsistencies. @node MIPS FP ABI Variants @@ -933,7 +933,7 @@ of MIPS32r2. @cindex @code{.module fp=@var{nn}} directive, MIPS In order to simplify and add safety to the process of selecting the correct floating-point ABI, the assembler will automatically infer the -correct @code{.gnu_attribute 4, @var{n}} directive based on command line +correct @code{.gnu_attribute 4, @var{n}} directive based on command-line options and @code{.module} overrides. Where an explicit @code{.gnu_attribute 4, @var{n}} directive has been seen then a warning will be raised if it does not match an inferred setting. |