Messages in this thread | | | Date | Wed, 4 Nov 2015 12:33:29 -0800 | From | Brian Norris <> | Subject | Re: [PATCH v2 3/4] get_maintainer: add --no-foo options to --help |
| |
On Wed, Nov 04, 2015 at 11:48:44AM -0800, Joe Perches wrote: > On Wed, 2015-11-04 at 11:28 -0800, Brian Norris wrote: > > Many flag options are boolean and support both a positive and a negative > > invocation from the command line. Some of these are even mentioned by > > example (e.g., --nogit is mentioned as a default option), but they > > aren't explicitly mentioned in the list of options. It happens that some > > of these are pretty important, as they are default-on, and to turn them > > off, you have to know about the --no-foo version. > [] > > v1 -> v2: > > * don't clutter with --[no]foo bracketing; just include this note up front; > > suggested by Joe > [] > > diff --git a/scripts/get_maintainer.pl b/scripts/get_maintainer.pl > [] > > @@ -770,6 +770,9 @@ usage: $P [options] patchfile > > $P [options] -f file|directory > > version: $V > > > > +Most options have both positive and negative forms. The negative form of --foo > > +is --nofoo. > > + > > MAINTAINER field selection options: > > --email => print email address(es) if any > > --git => include recent git \*-by: signers > > Hey Brian. > > Thanks for the series. > > It all seems sensible except this should be below the > options instead of above it. I would put it last in > the "Notes: " block just above the EOT marker.
Oh, I completely overlooked the 'Notes' section when doing this :) I was just imitating the placement in 'man gcc', where the note is in the DESCSRIPTION, which comes before all the options. But your suggestion does seem like a good place.
> I would have broken the lines like: > > Most options have both positive and negative forms. > The negative forms for --<foo> are --no<foo> and --no-<foo>.
OK, so in the Notes section, there's a form of second-line indentation, so I guess this?
Most options have both positive and negative forms. The negative forms for --<foo> are --no<foo> and --no-<foo>.
> So, if you could please respin and resend the series with > that change, I'll ack it.
Will do shortly.
Regards, Brian
| |