[PATCH][GCC][DOC] Relocate list under Deprecated in options.texi to Var

[PATCH][GCC][DOC] Relocate list under Deprecated in options.texi to Var

[Sam Tebbs]

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

Hi all,

I recently found what seems to be an error in the options documentation
(gcc/doc/options.texi) where a list describing how _var_ is set (referring to
the Var attribute) is written beneath the _Deprecated_ attribute instead. This
patch moves it to the correct location.

gcc/doc
2018-05-10  Sam Tebbs  <sam.tebbs@arm.com>

	* options.texi (Deprecated): Move list to Var section.

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

diff --git a/gcc/doc/options.texi b/gcc/doc/options.texi
index f887d16f88f8e22d280d0ab20a6fde05eb86e3d8..e618b9543511fa102a45c521fe6bd7759c73ef8d 100644
--- a/gcc/doc/options.texi
+++ b/gcc/doc/options.texi
@@ -314,6 +314,15 @@ The way that the state is stored depends on the type of option:
 The option is deprecated and every usage of such option will
 result in a warning.
 
+@item Var(@var{var}, @var{set})
+The option controls an integer variable @var{var} and is active when
+@var{var} equals @var{set}.  The option parser will set @var{var} to
+@var{set} when the positive form of the option is used and @code{!@var{set}}
+when the ``no-'' form is used.
+
+@var{var} is declared in the same way as for the single-argument form
+described above.
+
 @itemize @bullet
 @item
 If the option uses the @code{Mask} or @code{InverseMask} properties,
@@ -351,15 +360,6 @@ and wasn't given.
 The option-processing script will usually zero-initialize @var{var}.
 You can modify this behavior using @code{Init}.
 
-@item Var(@var{var}, @var{set})
-The option controls an integer variable @var{var} and is active when
-@var{var} equals @var{set}.  The option parser will set @var{var} to
-@var{set} when the positive form of the option is used and @code{!@var{set}}
-when the ``no-'' form is used.
-
-@var{var} is declared in the same way as for the single-argument form
-described above.
-
 @item Init(@var{value})
 The variable specified by the @code{Var} property should be statically
 initialized to @var{value}.  If more than one option using the same

Re: [PATCH][GCC][DOC] Relocate list under Deprecated in options.texi to Var

[Sam Tebbs]

On 10/05/2018 01:11 PM, Sam Tebbs wrote:

> Hi all,
>
> I recently found what seems to be an error in the options documentation
> (gcc/doc/options.texi) where a list describing how _var_ is set (referring to
> the Var attribute) is written beneath the _Deprecated_ attribute instead. This
> patch moves it to the correct location.
>
> gcc/doc
> 2018-05-10  Sam Tebbs  <sam.tebbs@arm.com>
>
> 	* options.texi (Deprecated): Move list to Var section.
ping

Re: [PATCH][GCC][DOC] Relocate list under Deprecated in options.texi to Var

[Martin Liška]

On 10/24/18 4:26 PM, Sam Tebbs wrote:
> On 10/05/2018 01:11 PM, Sam Tebbs wrote:
> 
>> Hi all,
>>
>> I recently found what seems to be an error in the options documentation
>> (gcc/doc/options.texi) where a list describing how _var_ is set (referring to
>> the Var attribute) is written beneath the _Deprecated_ attribute instead. This
>> patch moves it to the correct location.
>>
>> gcc/doc
>> 2018-05-10  Sam Tebbs  <sam.tebbs@arm.com>
>>
>> 	* options.texi (Deprecated): Move list to Var section.
> ping
> 

Hi.

I'm not documentation maintainer, but it looks obvious to me.
That said I would install the patch.

Martin

Re: [PATCH][GCC][DOC] Relocate list under Deprecated in options.texi to Var

[Jeff Law]

On 10/5/18 6:11 AM, Sam Tebbs wrote:
> Hi all,
> 
> I recently found what seems to be an error in the options documentation
> (gcc/doc/options.texi) where a list describing how _var_ is set (referring to
> the Var attribute) is written beneath the _Deprecated_ attribute instead. This
> patch moves it to the correct location.
> 
> gcc/doc
> 2018-05-10  Sam Tebbs  <sam.tebbs@arm.com>
> 
> 	* options.texi (Deprecated): Move list to Var section.
OK.
jeff

Re: [PATCH][GCC][DOC] Relocate list under Deprecated in options.texi to Var

[Sam Tebbs]

On 10/24/2018 03:26 PM, Sam Tebbs wrote:

> On 10/05/2018 01:11 PM, Sam Tebbs wrote:
>
>> Hi all,
>>
>> I recently found what seems to be an error in the options documentation
>> (gcc/doc/options.texi) where a list describing how _var_ is set (referring to
>> the Var attribute) is written beneath the _Deprecated_ attribute instead. This
>> patch moves it to the correct location.
>>
>> gcc/doc
>> 2018-05-10  Sam Tebbs  <sam.tebbs@arm.com>
>>
>> 	* options.texi (Deprecated): Move list to Var section.
> ping

Thank you Jeff and Martin. Committed as r265480.

Sam

Re: [PATCH][GCC][DOC] Relocate list under Deprecated in options.texi to Var

[Andrew Pinski]

On Fri, Oct 5, 2018 at 5:11 AM Sam Tebbs <sam.tebbs@arm.com> wrote:
>
> Hi all,
>
> I recently found what seems to be an error in the options documentation
> (gcc/doc/options.texi) where a list describing how _var_ is set (referring to
> the Var attribute) is written beneath the _Deprecated_ attribute instead. This
> patch moves it to the correct location.

Note even though this patch was definitely an improvement, it didn't
fix the docs fully. I filed https://gcc.gnu.org/PR107966 to record the
problem still.
If I get some time during the winter break, I will submit a full patch
to move around the text better.

Thanks,
Andrew Pinski

>
> gcc/doc
> 2018-05-10  Sam Tebbs  <sam.tebbs@arm.com>
>
>         * options.texi (Deprecated): Move list to Var section.