[gas] Use command line consistently in gas doc

Message ID ffd2e5dd-0782-35ce-a06b-e92910a2760a@foss.arm.com
State New
Headers show
Series
  • [gas] Use command line consistently in gas doc
Related show

Commit Message

Thomas Preudhomme Feb. 20, 2018, 9:48 a.m.
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.

Best regards,

Thomas

Comments

Richard Earnshaw (lists) Feb. 20, 2018, 10:25 a.m. | #1
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

>
Thomas Preudhomme Feb. 20, 2018, 10:43 a.m. | #2
Hi Richard,

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".


I agree and my first attempt was changing it in this way but a grep for 
command.line shows that "command line" is used all over the place and 
command-line very seldomly. I went for consistency.

Best regards,

Thomas
Thomas Preudhomme Feb. 21, 2018, 9:46 a.m. | #3
I've looked into the sort of usage for "command line" in the existing doc in 
case it was used in a different way. The words "command line option" (or 
command-line argument) seems the most frequent usage. Most target use "command 
line option" but some target use "command-line option". as.texinfo use a mix of 
both.

I've looked at bfd and binutils documentation and again "command line" is the 
most common with few examples of "command-line". Should we take advantage of 
this patch to bring consistency to the whole of gas documentation then? What 
should the consistent use be? "command-line" or "command line"?

Best regards,

Thomas

On 20/02/18 10:43, Thomas Preudhomme wrote:
> Hi Richard,

> 

> 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".

> 

> I agree and my first attempt was changing it in this way but a grep for 

> command.line shows that "command line" is used all over the place and 

> command-line very seldomly. I went for consistency.

> 

> Best regards,

> 

> Thomas

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