[patch] fix typos and grammar in -fuse-linker-plugin docs

[patch] fix typos and grammar in -fuse-linker-plugin docs

[Jonathan Wakely]

[-- Attachment #1: Type: text/plain, Size: 523 bytes --]

2011-05-06  Jonathan Wakely  <jwakely.gcc@gmail.com>

        * doc/invoke.texi (-fuse-linker-plugin): Improve grammar.

I was going to commit a smaller version of this patch as obvious (just
the second of the three hunks in the patch) but I spotted a few other
improvements that could be made. I think my changes preserve the
intended meaning, but improve the English slightly and (I hope)
clarify it.

OK for trunk?

Would removing "do" from "and shared libraries that do use hidden
visibility" be a further improvement?

[-- Attachment #2: invoke.txt --]
[-- Type: text/plain, Size: 1466 bytes --]

Index: doc/invoke.texi
===================================================================
--- doc/invoke.texi	(revision 173499)
+++ doc/invoke.texi	(working copy)
@@ -7701,17 +7701,17 @@
 Disabled by default.
 
 @item -fuse-linker-plugin
-Enables the use of linker plugin during link time optimization.  This option
-relies on the linker plugin support in linker that is available in gold
+Enables the use of a linker plugin during link time optimization.  This option
+relies on plugin support in the linker, which is available in gold
 or in GNU ld 2.21 or newer.
 
 This option enables the extraction of object files with GIMPLE bytecode out of
 library archives. This improves the quality of optimization by exposing more
-code the link time optimizer.  This information specify what symbols
+code to the link time optimizer.  This information specifies what symbols 
 can be accessed externally (by non-LTO object or during dynamic linking).
 Resulting code quality improvements on binaries (and shared libraries that do
-use hidden visibility) is similar to @code{-fwhole-program}.  See
-@option{-flto} for a description on the effect of this flag and how to use it.
+use hidden visibility) are similar to @code{-fwhole-program}.  See
+@option{-flto} for a description of the effect of this flag and how to use it.
 
 Enabled by default when LTO support in GCC is enabled and GCC was compiled
 with a linker supporting plugins (GNU ld 2.21 or newer or gold).

Re: [patch] fix typos and grammar in -fuse-linker-plugin docs

[Gerald Pfeifer]

On Fri, 6 May 2011, Jonathan Wakely wrote:
> 2011-05-06  Jonathan Wakely  <jwakely.gcc@gmail.com>
> 
>         * doc/invoke.texi (-fuse-linker-plugin): Improve grammar.
> 
> I was going to commit a smaller version of this patch as obvious (just
> the second of the three hunks in the patch) but I spotted a few other
> improvements that could be made. I think my changes preserve the
> intended meaning, but improve the English slightly and (I hope)
> clarify it.

This looks good, thank you!  (Some of the lines touched seem a bit
long? Perhaps wrap them?)

> Would removing "do" from "and shared libraries that do use hidden
> visibility" be a further improvement?

That I better leave to the native speakers here. :-)

Gerald

Re: [patch] fix typos and grammar in -fuse-linker-plugin docs

[Jonathan Wakely]

[-- Attachment #1: Type: text/plain, Size: 1067 bytes --]

On 7 May 2011 22:33, Gerald Pfeifer <gerald@pfeifer.com> wrote:
> On Fri, 6 May 2011, Jonathan Wakely wrote:
>> 2011-05-06  Jonathan Wakely  <jwakely.gcc@gmail.com>
>>
>>         * doc/invoke.texi (-fuse-linker-plugin): Improve grammar.
>>
>> I was going to commit a smaller version of this patch as obvious (just
>> the second of the three hunks in the patch) but I spotted a few other
>> improvements that could be made. I think my changes preserve the
>> intended meaning, but improve the English slightly and (I hope)
>> clarify it.
>
> This looks good, thank you!  (Some of the lines touched seem a bit
> long? Perhaps wrap them?)

Done.

>> Would removing "do" from "and shared libraries that do use hidden
>> visibility" be a further improvement?
>
> That I better leave to the native speakers here. :-)

I made the call and removed the "do", and committed the attached
version to trunk.

Thanks,

Jonathan

2011-05-08  Jonathan Wakely  <jwakely.gcc@gmail.com>

        * doc/invoke.texi (-fuse-linker-plugin): Improve grammar.

[-- Attachment #2: invoke.txt --]
[-- Type: text/plain, Size: 1775 bytes --]

Index: doc/invoke.texi
===================================================================
--- doc/invoke.texi	(revision 173528)
+++ doc/invoke.texi	(working copy)
@@ -7701,17 +7701,18 @@
 Disabled by default.
 
 @item -fuse-linker-plugin
-Enables the use of linker plugin during link time optimization.  This option
-relies on the linker plugin support in linker that is available in gold
+Enables the use of a linker plugin during link time optimization.  This
+option relies on plugin support in the linker, which is available in gold
 or in GNU ld 2.21 or newer.
 
-This option enables the extraction of object files with GIMPLE bytecode out of
-library archives. This improves the quality of optimization by exposing more
-code the link time optimizer.  This information specify what symbols
-can be accessed externally (by non-LTO object or during dynamic linking).
-Resulting code quality improvements on binaries (and shared libraries that do
-use hidden visibility) is similar to @code{-fwhole-program}.  See
-@option{-flto} for a description on the effect of this flag and how to use it.
+This option enables the extraction of object files with GIMPLE bytecode out
+of library archives. This improves the quality of optimization by exposing
+more code to the link time optimizer.  This information specifies what
+symbols can be accessed externally (by non-LTO object or during dynamic
+linking).  Resulting code quality improvements on binaries (and shared
+libraries that use hidden visibility) are similar to @code{-fwhole-program}.
+See @option{-flto} for a description of the effect of this flag and how to
+use it.
 
 Enabled by default when LTO support in GCC is enabled and GCC was compiled
 with a linker supporting plugins (GNU ld 2.21 or newer or gold).