From: Richard Sandiford <rdsandiford@googlemail.com>
Date: Thu, 14 Apr 2011 11:52:17 +0000 (+0000)
Subject: options.texi (Negative): Explicitly mention that the Negative chain must be circular.
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=77b104859e6bc366202bafa2f0490aa8f05ba4a1;p=gcc.git

options.texi (Negative): Explicitly mention that the Negative chain must be circular.

gcc/
	* doc/options.texi (Negative): Explicitly mention that the
	Negative chain must be circular.

From-SVN: r172419
---

diff --git a/gcc/ChangeLog b/gcc/ChangeLog
index 0aa3fab8086..a0c881d445d 100644
--- a/gcc/ChangeLog
+++ b/gcc/ChangeLog
@@ -1,3 +1,8 @@
+2011-04-14  Richard Sandiford  <rdsandiford@googlemail.com>
+
+	* doc/options.texi (Negative): Explicitly mention that the
+	Negative chain must be circular.
+
 2011-04-14  Nathan Froyd  <froydnj@codesourcery.com>
 
 	* function.h (block_chainon): Declare.
diff --git a/gcc/doc/options.texi b/gcc/doc/options.texi
index 69e73645893..edab7a9da66 100644
--- a/gcc/doc/options.texi
+++ b/gcc/doc/options.texi
@@ -222,6 +222,13 @@ the option name with the leading ``-'' removed.  This chain action will
 propagate through the @code{Negative} property of the option to be
 turned off.
 
+As a consequence, if you have a group of mutually-exclusive
+options, their @code{Negative} properties should form a circular chain.
+For example, if options @option{-@var{a}}, @option{-@var{b}} and
+@option{-@var{c}} are mutually exclusive, their respective @code{Negative}
+properties should be @samp{Negative(@var{b})}, @samp{Negative(@var{c})}
+and @samp{Negative(@var{a})}.
+
 @item Joined
 @itemx Separate
 The option takes a mandatory argument.  @code{Joined} indicates