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 /gprof | |
parent | f2075844e2d4dc0f3f0d15b1acf20651f19cbb33 (diff) | |
download | binutils-a05a5b64cf33d36d93a92fd03ae900e18dbe5572.zip binutils-a05a5b64cf33d36d93a92fd03ae900e18dbe5572.tar.gz binutils-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 'gprof')
-rw-r--r-- | gprof/ChangeLog | 5 | ||||
-rw-r--r-- | gprof/gprof.texi | 6 |
2 files changed, 8 insertions, 3 deletions
diff --git a/gprof/ChangeLog b/gprof/ChangeLog index f57729d..ce748f6 100644 --- a/gprof/ChangeLog +++ b/gprof/ChangeLog @@ -1,3 +1,8 @@ +2018-07-02 Thomas Preud'homme <thomas.preudhomme@arm.com> + + * gprof.texi: Use command-line consistently when used in a compount + word. + 2018-06-24 Nick Clifton <nickc@redhat.com> * configure: Regenerate. diff --git a/gprof/gprof.texi b/gprof/gprof.texi index bdcda00..456805b 100644 --- a/gprof/gprof.texi +++ b/gprof/gprof.texi @@ -331,7 +331,7 @@ initialised. This is usually detected by the program encountering a segmentation fault as soon as it is run. The solution is to link against a static version of the library containing the profiling support code, which for @code{gcc} users can be done via the -@samp{-static} or @samp{-static-libgcc} command line option. For +@samp{-static} or @samp{-static-libgcc} command-line option. For example: @example @@ -357,7 +357,7 @@ there is still support for displaying this kind of information in @code{gprof}. @xref{Line-by-line, ,Line-by-line Profiling}. It also worth noting that @code{gcc} implements a -@samp{-finstrument-functions} command line option which will insert +@samp{-finstrument-functions} command-line option which will insert calls to special user supplied instrumentation routines at the entry and exit of every function in their program. This can be used to implement an alternative profiling scheme. @@ -1431,7 +1431,7 @@ With the older versions of @code{gcc} the program usually has to be compiled with a @samp{-g} option, in addition to @samp{-pg}, in order to generate debugging symbols for tracking source code lines. Note, in much older versions of @code{gcc} the program had to be -compiled with the @samp{-a} command line option as well. +compiled with the @samp{-a} command-line option as well. The flat profile is the most useful output table in line-by-line mode. |