aboutsummaryrefslogtreecommitdiff
path: root/gas/doc/as.texi
diff options
context:
space:
mode:
authorThomas Preud'homme <thomas.preudhomme@arm.com>2018-07-02 11:18:24 +0100
committerThomas Preud'homme <thomas.preudhomme@arm.com>2018-07-02 11:18:24 +0100
commita05a5b64cf33d36d93a92fd03ae900e18dbe5572 (patch)
tree15b75a1cf3c0fc782160e6e592c63d822e312e6e /gas/doc/as.texi
parentf2075844e2d4dc0f3f0d15b1acf20651f19cbb33 (diff)
downloadgdb-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/as.texi')
-rw-r--r--gas/doc/as.texi18
1 files changed, 9 insertions, 9 deletions
diff --git a/gas/doc/as.texi b/gas/doc/as.texi
index 493049c..49b1ef1 100644
--- a/gas/doc/as.texi
+++ b/gas/doc/as.texi
@@ -757,7 +757,7 @@ configure option.
@end ifset
@item --help
-Print a summary of the command line options and exit.
+Print a summary of the command-line options and exit.
@item --target-help
Print a summary of all target specific options and exit.
@@ -1607,12 +1607,12 @@ an MCore processor.
@item -jsri2bsr
@itemx -nojsri2bsr
Enable or disable the JSRI to BSR transformation. By default this is enabled.
-The command line option @samp{-nojsri2bsr} can be used to disable it.
+The command-line option @samp{-nojsri2bsr} can be used to disable it.
@item -sifilter
@itemx -nosifilter
Enable or disable the silicon filter behaviour. By default this is disabled.
-The default can be overridden by the @samp{-sifilter} command line option.
+The default can be overridden by the @samp{-sifilter} command-line option.
@item -relax
Alter jump instructions for long displacements.
@@ -2011,7 +2011,7 @@ significant.
explicitly, as one of the files for @command{@value{AS}} to assemble.
@cindex options, command line
-Except for @samp{--} any command line argument that begins with a
+Except for @samp{--} any command-line argument that begins with a
hyphen (@samp{-}) is an option. Each option changes the behavior of
@command{@value{AS}}. No option changes the way another option works. An
option is a @samp{-} followed by one or more letters; the case of
@@ -2050,7 +2050,7 @@ program. The source program is made up of one or more files.
You give @command{@value{AS}} a command line that has zero or more input file
names. The input files are read (from left file name to right). A
-command line argument (in any position) that has no special meaning
+command-line argument (in any position) that has no special meaning
is taken to be an input file name.
If you give @command{@value{AS}} no file names it attempts to read one input file
@@ -2288,7 +2288,7 @@ The letters after @samp{-a} may be combined into one option,
Note if the assembler source is coming from the standard input (e.g.,
because it
-is being created by @code{@value{GCC}} and the @samp{-pipe} command line switch
+is being created by @code{@value{GCC}} and the @samp{-pipe} command-line switch
is being used) then the listing will not contain any comments or preprocessor
directives. This is because the listing code buffers input source lines from
stdin only after they have been preprocessed by the assembler. This reduces
@@ -2383,7 +2383,7 @@ in the object file. Usually if you do this you also tell the linker
@node listing
@section Configuring listing output: @option{--listing}
-The listing feature of the assembler can be enabled via the command line switch
+The listing feature of the assembler can be enabled via the command-line switch
@samp{-a} (@pxref{a}). This feature combines the input source file(s) with a
hex dump of the corresponding locations in the output object file, and displays
them as a listing file. The format of this listing can be controlled by
@@ -2777,7 +2777,7 @@ specific, and some targets multiple comment characters. Some targets also have
line comment characters that only work if they are the first character on a
line. Some targets use a sequence of two characters to introduce a line
comment. Some targets can also change their line comment characters depending
-upon command line options that have been used. For more details see the
+upon command-line options that have been used. For more details see the
@emph{Syntax} section in the documentation for individual targets.
If the line comment character is the hash sign (@samp{#}) then it still has the
@@ -5700,7 +5700,7 @@ counter, and @code{.nolist} decrements it. Assembly listings are
generated whenever the counter is greater than zero.
By default, listings are disabled. When you enable them (with the
-@samp{-a} command line option; @pxref{Invoking,,Command-Line Options}),
+@samp{-a} command-line option; @pxref{Invoking,,Command-Line Options}),
the initial value of the listing counter is one.
@node Ln