linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Brian Norris <computersforpeace@gmail.com>
To: Joe Perches <joe@perches.com>
Cc: linux-kernel@vger.kernel.org, Andrew Morton <akpm@linux-foundation.org>
Subject: Re: [PATCH v2 3/4] get_maintainer: add --no-foo options to --help
Date: Wed, 4 Nov 2015 12:33:29 -0800	[thread overview]
Message-ID: <20151104203329.GO7274@google.com> (raw)
In-Reply-To: <1446666524.21133.63.camel@perches.com>

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

  reply	other threads:[~2015-11-04 20:33 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-11-04 19:28 [PATCH v2 1/4] get_maintainer: add missing documentation for --git-blame-signatures Brian Norris
2015-11-04 19:28 ` [PATCH v2 2/4] get_maintainer: it's '--pattern-depth', not '-pattern-depth' Brian Norris
2015-11-04 19:28 ` [PATCH v2 3/4] get_maintainer: add --no-foo options to --help Brian Norris
2015-11-04 19:48   ` Joe Perches
2015-11-04 20:33     ` Brian Norris [this message]
2015-11-04 20:53     ` Brian Norris
2015-11-04 19:28 ` [PATCH v2 4/4] get_maintainer: --r (list reviewer) is on by default Brian Norris

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20151104203329.GO7274@google.com \
    --to=computersforpeace@gmail.com \
    --cc=akpm@linux-foundation.org \
    --cc=joe@perches.com \
    --cc=linux-kernel@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).