From a05a5b64cf33d36d93a92fd03ae900e18dbe5572 Mon Sep 17 00:00:00 2001 From: Thomas Preud'homme Date: Mon, 2 Jul 2018 11:18:24 +0100 Subject: 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 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. --- binutils/ChangeLog | 6 ++++++ binutils/NEWS | 34 +++++++++++++++++----------------- binutils/doc/binutils.texi | 38 +++++++++++++++++++------------------- 3 files changed, 42 insertions(+), 36 deletions(-) (limited to 'binutils') diff --git a/binutils/ChangeLog b/binutils/ChangeLog index 20c6bd7..4f3284a 100644 --- a/binutils/ChangeLog +++ b/binutils/ChangeLog @@ -1,3 +1,9 @@ +2018-07-02 Thomas Preud'homme + + * NEWS: Use command-line consistently when used in a compount word. + * doc/binutils.texi: Likewise and fix trailing whitespace on same + line. + 2018-06-26 Nick Clifton * po/sv.po: Updated Swedish translation. diff --git a/binutils/NEWS b/binutils/NEWS index 6b29a8a..a3890ed 100644 --- a/binutils/NEWS +++ b/binutils/NEWS @@ -66,11 +66,11 @@ Changes in 2.28: require an ABI update, affecting other assemblers and linkers that create and process the relocations correctly. It is recommended that all VLE object files be recompiled, but ld can modify the relocations - if --vle-reloc-fixup is passed to ld. If the new ld command line + if --vle-reloc-fixup is passed to ld. If the new ld command-line option is not used, ld will ld warn on finding relocations inconsistent with the instructions being relocated. -* The nm program has a new command line option (--with-version-strings) +* The nm program has a new command-line option (--with-version-strings) which will display a symbol's version information, if any, after the symbol's name. @@ -130,7 +130,7 @@ Changes in 2.25: Changes in 2.24: -* Objcopy now supports wildcard characters in command line options that take +* Objcopy now supports wildcard characters in command-line options that take section names. * Add support for Altera Nios II. @@ -173,10 +173,10 @@ changes in 2.21: * Add to dlltool .def file feature of aliasing PE internal symbol name by '== ' option. -* Add a new command line option -a / --addresses to addr2line to display the +* Add a new command-line option -a / --addresses to addr2line to display the address before function name or source filename. -* Add a new command line option -p / --pretty-print to addr2line to have +* Add a new command-line option -p / --pretty-print to addr2line to have a more human readable output. * The hppa/som targets can now be compiled on any host. @@ -189,14 +189,14 @@ Changes in 2.20: from the static delayimp library, which will import LoadLibraryA and GetProcAddress from kernel32. -* Add a new command line option, --insn-width=WIDTH, to objdump to specify +* Add a new command-line option, --insn-width=WIDTH, to objdump to specify number of bytes to be displayed on a single line when disassembling instructions. * Readelf can now display the relocated contents of a section as a sequence - of bytes via the --relocated-dump= command line option. + of bytes via the --relocated-dump= command-line option. -* The gprof program has been given a new command line option: +* The gprof program has been given a new command-line option: --external-symbols-table= which reads in symbols from a specified file. @@ -207,7 +207,7 @@ Changes in 2.20: for objcopy. * Add --file-alignment, --heap, --image-base, --section-alignment, - --stack and --subsystem command line options to objcopy, which will + --stack and --subsystem command-line options to objcopy, which will set PE optional header. * Option --dwarf/-W of objdump is now as flexible as readelf --debug-dump/-w. @@ -270,7 +270,7 @@ Changes in 2.18: re-compiled by windres without lossing resources or compilation errors. Some problems on dialog resource translations are corrected. -* Add --extract-symbol command line option to objcopy, which will +* Add --extract-symbol command-line option to objcopy, which will strip everything out of an ordinary object file or executable except for its symbol table. Files containing just symbols can be useful to some OSes. @@ -322,7 +322,7 @@ Changes in 2.16: * readelf can now display address ranges from .debug_range sections. This happens automatically when a DW_AT_range attribute is encountered. The - command line switch --debug-dump=Ranges (or -wR) can also be used to display + command-line switch --debug-dump=Ranges (or -wR) can also be used to display the contents of the .debug_range section. * nm and objdump now have a switch "--special-syms" to enable the displaying of @@ -404,17 +404,17 @@ Changes in version 2.12: * readelf: Support added for DWARF 2.1 extensions. Support added for displaying the contents of .debug.macinfo sections. -* New command line switches added to objcopy to allow symbols to be kept as +* New command-line switches added to objcopy to allow symbols to be kept as global symbols, and also to specify files containing lists of such symbols. by Honda Hiroki. * Support for OpenRISC by Johan Rydberg. -* New command line switch to objcopy --alt-machine-code which creates a binary +* New command-line switch to objcopy --alt-machine-code which creates a binary with an alternate machine code if one is defined in the architecture description. Only supported for ELF targets. By Alexandre Oliva. -* New command line switch to objcopy -B (or --binary-architecture) which sets +* New command-line switch to objcopy -B (or --binary-architecture) which sets the architecture of the output file to the given argument. This option only makes sense, if the input target is binary. Otherwise it is ignored. By Stefan Geuken. @@ -426,7 +426,7 @@ Changes in binutils 2.11: * Add support for ARM v5t and v5te architectures and Intel's XScale ARM extenstions. -* Add --srec-len and --srec-forceS3 command line switch to objcopy. +* Add --srec-len and --srec-forceS3 command-line switch to objcopy. By Luciano Gemme. * Support for the MIPS32, by Anders Norlander. @@ -439,11 +439,11 @@ Changes in binutils 2.10: * Support for 64-bit ELF on HPPA. -* New command line switch to objdump --file-start-context which shows the +* New command-line switch to objdump --file-start-context which shows the entire file contents up to the source line first encountered for a given file. -* New command line switch to objdump -M (or --disassembler-options) which takes +* New command-line switch to objdump -M (or --disassembler-options) which takes a parameter which can then be interpreted on a per-target basis by the disassembler. Used by ARM targets to select register name sets, ISA, APCS or raw verions. diff --git a/binutils/doc/binutils.texi b/binutils/doc/binutils.texi index 599c79e..e40ccb0 100644 --- a/binutils/doc/binutils.texi +++ b/binutils/doc/binutils.texi @@ -520,13 +520,13 @@ when the modifier @samp{v} is appended. This modifier shows the version number of @command{ar}. @end table -The @command{ar} program also supports some command line options which +The @command{ar} program also supports some command-line options which are neither modifiers nor actions, but which do change its behaviour in specific ways: @table @samp @item --help -Displays the list of command line options supported by @command{ar} +Displays the list of command-line options supported by @command{ar} and then exits. @item --version @@ -541,7 +541,7 @@ of the other @samp{-X} options; in particular, it does not support @item --plugin @var{name} @cindex plugins -The optional command line switch @option{--plugin @var{name}} causes +The optional command-line switch @option{--plugin @var{name}} causes @command{ar} to load the plugin called @var{name} which adds support for more file formats, including object files with link-time optimization information. @@ -564,7 +564,7 @@ is always backwards compatible with earlier versions, so it is sufficient to just copy the newest one. @item --target @var{target} -The optional command line switch @option{--target @var{bfdname}} +The optional command-line switch @option{--target @var{bfdname}} specifies that the archive members are in an object code format different from your system's default format. See @xref{Target Selection}, for more information. @@ -2852,7 +2852,7 @@ If none are specified, the file @code{a.out} will be used. @c man begin OPTIONS size -The command line options have the following meanings: +The command-line options have the following meanings: @table @env @item -A @@ -2980,7 +2980,7 @@ data sections. If the file type in unrecognizable, or if strings is reading from stdin then it will always display all of the printable sequences that it can find. -For backwards compatibility any file that occurs after a command line +For backwards compatibility any file that occurs after a command-line option of just @option{-} will also be scanned in full, regardless of the presence of any @option{-d} option. @@ -3430,7 +3430,7 @@ If no @var{symbol} arguments are given, @command{c++filt} reads symbol names from the standard input instead. All the results are printed on the standard output. The difference between reading names from the command line versus reading names from the standard input is that -command line arguments are expected to be just mangled names and no +command-line arguments are expected to be just mangled names and no checking is performed to separate them from surrounding text. Thus for example: @@ -3804,7 +3804,7 @@ current directory. @item -H @itemx --help -Displays a list of command line options and then exits. +Displays a list of command-line options and then exits. @item -m @var{characters} @itemx --maxlength @var{characters} @@ -4166,7 +4166,7 @@ which in turn will import LoadLibraryA and GetProcAddress from kernel32. @command{dlltool} builds the library file by hand, but it builds the exports file by creating temporary files containing assembler statements -and then assembling these. The @option{-S} command line option can be +and then assembling these. The @option{-S} command-line option can be used to specify the path to the assembler that dlltool will use, and the @option{-f} option can be used to pass specific flags to that assembler. The @option{-n} can be used to prevent dlltool from deleting @@ -4194,7 +4194,7 @@ description of the @option{-I} or @option{--identify} option. @c man begin OPTIONS dlltool -The command line options have the following meanings: +The command-line options have the following meanings: @table @env @@ -4260,7 +4260,7 @@ to create the exports file. @item -f @var{options} @itemx --as-flags @var{options} -Specifies any specific command line options to be passed to the +Specifies any specific command-line options to be passed to the assembler when building the exports file. This option will work even if the @option{-S} option is not used. This option only takes one argument, and if it occurs more than once on the command line, then later @@ -4387,7 +4387,7 @@ Make dlltool describe what it is doing. @item -h @itemx --help -Displays a list of command line options and then exits. +Displays a list of command-line options and then exits. @item -V @itemx --version @@ -4695,7 +4695,7 @@ single line, which is far more readable on terminals wider than 80 columns. @item -H @itemx --help -Display the command line options understood by @command{readelf}. +Display the command-line options understood by @command{readelf}. @end table @@ -4789,7 +4789,7 @@ Display the version number of @command{elfedit}. @item -h @itemx --help -Display the command line options understood by @command{elfedit}. +Display the command-line options understood by @command{elfedit}. @end table @@ -4882,7 +4882,7 @@ Ways to specify: @enumerate @item -command line option: @option{-b} or @option{--target} +command-line option: @option{-b} or @option{--target} @item environment variable @code{GNUTARGET} @@ -4897,7 +4897,7 @@ Ways to specify: @enumerate @item -command line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target} +command-line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target} @item environment variable @code{GNUTARGET} @@ -4912,7 +4912,7 @@ Ways to specify: @enumerate @item -command line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target} +command-line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target} @item the input target (see ``@command{objcopy} and @command{strip} Input Target'' above) @@ -4930,7 +4930,7 @@ Ways to specify: @enumerate @item -command line option: @option{--target} +command-line option: @option{--target} @item environment variable @code{GNUTARGET} @@ -4957,7 +4957,7 @@ Ways to specify: @enumerate @item -command line option: @option{-m} or @option{--architecture} +command-line option: @option{-m} or @option{--architecture} @item deduced from the input file -- cgit v1.1