[PATCH, binutils] Fix use of "command line X" in binutils doc
Thomas Preudhomme
thomas.preudhomme@foss.arm.com
Fri Jun 29 08:51:00 GMT 2018
Sorry, forgot to rebase before sending. Please find updated ChangeLog entries
and patch below.
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
ChangeLog entries are as follows:
*** bfd/ChangeLog ***
2018-02-27 Thomas Preud'homme <thomas.preudhomme@arm.com>
* doc/bfdint.texi: Use command-line consistently when used in a
compount word.
* doc/bfdsumm.texi: Likewise.
*** binutils/ChangeLog ***
2018-02-27 Thomas Preud'homme <thomas.preudhomme@arm.com>
* NEWS: Use command-line consistently when used in a compount word.
* doc/binutils.texi: Likewise.
*** gas/ChangeLog ***
2018-06-29 Thomas Preud'homme <thomas.preudhomme@arm.com>
* 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/ChangeLog ***
2018-02-27 Thomas Preud'homme <thomas.preudhomme@arm.com>
* gprof.texi: Use command-line consistently when used in a compount
word.
*** ld/ChangeLog ***
2018-02-27 Thomas Preud'homme <thomas.preudhomme@arm.com>
* NEWS: Use command-line consistently when used in a compount word.
* ld.texinfo: Likewise.
* ldint.texinfo: Likewise.
Testing: make html work except for unchanged readline. Tested that the
change to the "Command Line Options" section in ld.texinfo does not
break links to it.
Is this ok for master branch?
Best regards,
Thomas
On 29/06/18 09:14, Thomas Preudhomme wrote:
> Hi,
>
> 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
> words 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
>
> ChangeLog entries are as follows:
>
> *** bfd/ChangeLog ***
>
> 2018-02-27 Thomas Preud'homme <thomas.preudhomme@arm.com>
>
> Â Â Â Â * doc/bfdint.texi: Use command-line consistently when used in a
> Â Â Â Â compount word.
> Â Â Â Â * doc/bfdsumm.texi: Likewise.
>
> *** binutils/ChangeLog ***
>
> 2018-02-27 Thomas Preud'homme <thomas.preudhomme@arm.com>
>
> Â Â Â Â * NEWS: Use command-line consistently when used in a compount word.
> Â Â Â Â * doc/binutils.texi: Likewise.
>
> *** gas/ChangeLog ***
>
> 2018-02-27 Thomas Preud'homme <thomas.preudhomme@arm.com>
>
> Â Â Â Â * NEWS: Use command-line consistently when used in a compount word.
> Â Â Â Â * doc/as.texinfo: 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/ChangeLog ***
>
> 2018-02-27 Thomas Preud'homme <thomas.preudhomme@arm.com>
>
> Â Â Â Â * gprof.texi: Use command-line consistently when used in a compount
> Â Â Â Â word.
>
> *** ld/ChangeLog ***
>
> 2018-02-27 Thomas Preud'homme <thomas.preudhomme@arm.com>
>
> Â Â Â Â * NEWS: Use command-line consistently when used in a compount word.
> Â Â Â Â * ld.texinfo: Likewise.
> Â Â Â Â * ldint.texinfo: Likewise.
>
> Testing: make html work except for unchanged readline. Tested that the
> change to the "Command Line Options" section in ld.texinfo does not
> break links to it.
>
> Is this ok for master branch?
>
> Best regards,
>
> Thomas
>
> On 20/02/18 10:25, Richard Earnshaw (lists) wrote:
>> On 20/02/18 09:48, Thomas Preudhomme wrote:
>>> Hi,
>>>
>>> c-aarch64.texi and c-arm.texi contain several occurrences of commandline
>>> instead of "command line" which the rest of gas documentation seems to
>>> have settled on. This patch changes these occurences for better
>>> consistency.
>>>
>>> ChangeLog entry is as follows:
>>>
>>> *** gas/ChangeLog ***
>>>
>>> 2018-02-19 Thomas Preud'homme <thomas.preudhomme@arm.com>
>>>
>>> Â Â Â Â Â Â Â Â * doc/c-aarch64.texi: Replace uses of "commandline" by "command
>>> line".
>>> Â Â Â Â Â Â Â Â * doc/c-arm.texi: Likewise.
>>>
>>> Committed as obvious.
>>
>> If I remember my English grammar correctly, since the cases you change
>> here all use "command line" to qualify a noun ("option") I think they
>> should be hyphenated, so "command-line option".
>>
>> R.
>>
>>>
>>> Best regards,
>>>
>>> Thomas
>>>
>>> fix_commandline_typo.patch
>>>
>>>
>>> diff --git a/gas/doc/c-aarch64.texi b/gas/doc/c-aarch64.texi
>>> index
>>> 56aa7e1636c5fbab0d69d9e4c335c8d1ba238252..d4aa7291d7496d4d3051faac2058da1d21dd2a28
>>> 100644
>>> --- a/gas/doc/c-aarch64.texi
>>> +++ b/gas/doc/c-aarch64.texi
>>> @@ -284,7 +284,7 @@ The AArch64 architecture uses @sc{ieee} floating-point
>>> numbers.
>>> Â @cindex @code{.arch} directive, AArch64
>>> Â @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.
>>> @@ -293,7 +293,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} commandline option.
>>> +extensions by the @option{-mcpu} command line option.
>>> Â @code{.arch_extension} may be used multiple times to add or remove extensions
>>> Â incrementally to the architecture being compiled for.
>>> diff --git a/gas/doc/c-arm.texi b/gas/doc/c-arm.texi
>>> index
>>> f67696f00fbbbf76627d41cf45b682432e272ba8..a53956ea505d168038d987325afe6190cc271c51
>>> 100644
>>> --- a/gas/doc/c-arm.texi
>>> +++ b/gas/doc/c-arm.texi
>>> @@ -622,7 +622,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.
>>> @@ -631,7 +631,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.
>>> @@ -661,7 +661,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.
>>> @@ -769,7 +769,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
>>>
>>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: fix_command_line_use.patch
Type: text/x-patch
Size: 115358 bytes
Desc: not available
URL: <https://sourceware.org/pipermail/binutils/attachments/20180629/45a131a7/attachment.bin>
More information about the Binutils
mailing list