[PATCH] Clarify documentation for -fpie and -fPIE

[PATCH] Clarify documentation for -fpie and -fPIE

[Jonathan Wakely]

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

I noticed a couple of missing definite articles in the description of
-fpie and -fPIE, and found the last sentence unclear. This clarifies
that it means you should use these options during compilation if you
plan to use -pie during linking (rather than implying you use these
during linking as well).

I also added a hyphen to "position independent" but maybe that part
should wait for a decision on
https://gcc.gnu.org/ml/gcc/2018-04/msg00196.html


	* doc/invoke.texi (-fpie, -fPIE): Fix grammar and clarify
	interaction with -pie.

OK for trunk?


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

commit 169e8c617d502eae8ef37ea60cd199286d318863
Author: Jonathan Wakely <jwakely@redhat.com>
Date:   Mon Apr 30 13:26:10 2018 +0100

    Clarify documentation for -fpie and -fPIE
    
            * doc/invoke.texi (-fpie, -fPIE): Fix grammar and clarify
            interaction with -pie.

diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
index 606e9152cfc..efe66e37901 100644
--- a/gcc/doc/invoke.texi
+++ b/gcc/doc/invoke.texi
@@ -13094,10 +13094,10 @@ are defined to 2.
 @itemx -fPIE
 @opindex fpie
 @opindex fPIE
-These options are similar to @option{-fpic} and @option{-fPIC}, but
-generated position independent code can be only linked into executables.
-Usually these options are used when @option{-pie} GCC option is
-used during linking.
+These options are similar to @option{-fpic} and @option{-fPIC}, but the
+generated position-independent code can be only linked into executables.
+Usually these options are used to compile code that will be linked using
+the @option{-pie} GCC option.
 
 @option{-fpie} and @option{-fPIE} both define the macros
 @code{__pie__} and @code{__PIE__}.  The macros have the value 1

Re: [PATCH] Clarify documentation for -fpie and -fPIE

[Jeff Law]

On 04/30/2018 06:51 AM, Jonathan Wakely wrote:
> I noticed a couple of missing definite articles in the description of
> -fpie and -fPIE, and found the last sentence unclear. This clarifies
> that it means you should use these options during compilation if you
> plan to use -pie during linking (rather than implying you use these
> during linking as well).
> 
> I also added a hyphen to "position independent" but maybe that part
> should wait for a decision on
> https://gcc.gnu.org/ml/gcc/2018-04/msg00196.html
> 
> 
>     * doc/invoke.texi (-fpie, -fPIE): Fix grammar and clarify
>     interaction with -pie.
> 
> OK for trunk?
> 
OK
jeff