docs: fix Var documentation for .opt files

Message ID d23be938-e91f-2f5b-f85f-c9e8105e272b@suse.cz
State Accepted
Headers
Series docs: fix Var documentation for .opt files |

Checks

Context Check Description
snail/gcc-patch-check success Github commit url

Commit Message

Martin Liška Dec. 28, 2022, 9:18 a.m. UTC
  The Var documentation was somehow wrongly split into 2 pieces.

	PR middle-end/107966

gcc/ChangeLog:

	* doc/options.texi: Fix Var documentation in internal manual.
---
 gcc/doc/options.texi | 26 +++++++++++++-------------
 1 file changed, 13 insertions(+), 13 deletions(-)
  

Comments

Gerald Pfeifer Jan. 4, 2023, 9:57 a.m. UTC | #1
On Wed, 28 Dec 2022, Martin Liška wrote:
> The Var documentation was somehow wrongly split into 2 pieces.
> 
> 	PR middle-end/107966

And on top of that those two bits you are merging were not 
sorted in alphabetically - which your patch also addresses. :-)

> gcc/ChangeLog:
> 
> 	* doc/options.texi: Fix Var documentation in internal manual.

Looks good to me; thank you!

Gerald
  

Patch

diff --git a/gcc/doc/options.texi b/gcc/doc/options.texi
index 17ba923890e..39a2d1a0d43 100644
--- a/gcc/doc/options.texi
+++ b/gcc/doc/options.texi
@@ -340,19 +340,6 @@  The state of this option should be stored in variable @var{var}
 (actually a macro for @code{global_options.x_@var{var}}).
 The way that the state is stored depends on the type of option:
 
-@item WarnRemoved
-The option is removed and every usage of such option will
-result in a warning.  We use it option backward compatibility.
-
-@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,
@@ -390,11 +377,24 @@  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
 variable specifies @code{Init}, all must specify the same initializer.
 
+@item WarnRemoved
+The option is removed and every usage of such option will
+result in a warning.  We use it option backward compatibility.
+
 @item Mask(@var{name})
 The option is associated with a bit in the @code{target_flags}
 variable (@pxref{Run-time Target}) and is active when that bit is set.