From patchwork Wed Apr 13 12:48:44 2011 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Richard Sandiford X-Patchwork-Id: 998 Return-Path: Delivered-To: unknown Received: from imap.gmail.com (74.125.159.109) by localhost6.localdomain6 with IMAP4-SSL; 08 Jun 2011 14:48:08 -0000 Delivered-To: patches@linaro.org Received: by 10.68.59.138 with SMTP id z10cs305802pbq; Wed, 13 Apr 2011 05:48:49 -0700 (PDT) Received: by 10.227.153.152 with SMTP id k24mr6703076wbw.3.1302698928481; Wed, 13 Apr 2011 05:48:48 -0700 (PDT) Received: from mail-ww0-f50.google.com (mail-ww0-f50.google.com [74.125.82.50]) by mx.google.com with ESMTPS id j5si991742wbc.45.2011.04.13.05.48.47 (version=TLSv1/SSLv3 cipher=OTHER); Wed, 13 Apr 2011 05:48:48 -0700 (PDT) Received-SPF: neutral (google.com: 74.125.82.50 is neither permitted nor denied by best guess record for domain of richard.sandiford@linaro.org) client-ip=74.125.82.50; Authentication-Results: mx.google.com; spf=neutral (google.com: 74.125.82.50 is neither permitted nor denied by best guess record for domain of richard.sandiford@linaro.org) smtp.mail=richard.sandiford@linaro.org Received: by wwc33 with SMTP id 33so600870wwc.31 for ; Wed, 13 Apr 2011 05:48:47 -0700 (PDT) Received: by 10.216.81.69 with SMTP id l47mr5099887wee.78.1302698927615; Wed, 13 Apr 2011 05:48:47 -0700 (PDT) Received: from richards-thinkpad (gbibp9ph1--blueice2n1.emea.ibm.com [195.212.29.75]) by mx.google.com with ESMTPS id bd8sm322863wbb.14.2011.04.13.05.48.45 (version=TLSv1/SSLv3 cipher=OTHER); Wed, 13 Apr 2011 05:48:46 -0700 (PDT) From: Richard Sandiford To: gcc-patches@gcc.gnu.org Mail-Followup-To: gcc-patches@gcc.gnu.org, patches@linaro.org, richard.sandiford@linaro.org Cc: patches@linaro.org Subject: Tweak Negative() documentation in options.texi Date: Wed, 13 Apr 2011 13:48:44 +0100 Message-ID: User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/23.1 (gnu/linux) MIME-Version: 1.0 I was looking at a backport of the current linux.opt, and got confused by the chain of three Negative()s. I was thinking that saying "A is Negative(B)" was equivalent to saying A == !B. This patch is an attempt to clarify the documentation. Tested with "make doc", "make html" and "make pdf". OK to install? Richard gcc/ * doc/options.texi (Negative): Explicitly mention that the Negative chain must be circular. Index: gcc/doc/options.texi =================================================================== --- gcc/doc/options.texi 2011-04-07 09:23:22.000000000 +0100 +++ gcc/doc/options.texi 2011-04-13 13:42:24.000000000 +0100 @@ -222,6 +222,13 @@ the option name with the leading ``-'' r 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