Re: [PATCH] revision.c: introduce --notes-ref= to use one notes ref only

From: Jeff King <peff@peff.net>
Date: Mar 29, 2011, 14:33 UTC
Message-ID: <20110329143357.GA10771@sigill.intra.peff.net>
In-Reply-To: <201103291439.17197.johan@herland.net>

On Tue, Mar 29, 2011 at 02:39:17PM +0200, Johan Herland wrote:

Show 16 quoted lines

> On Tuesday 29 March 2011, Michael J Gruber wrote:
> > As notes become increasingly popular, it's often interesting to show
> > notes from a particular notes ref only. Introduce '--notes-ref=<ref>'
> > as a convenience shortcut for '--no-standard-notes
> > --show-notes=<ref>'.
> >
> > Signed-off-by: Michael J Gruber <git@drmicha.warpmail.net>
> > ---
> > The idea is to use the same name as in "git notes --ref=<ref>" but
> > make it clear for the rev-list option to be about notes, thus
> > "--notes-ref=<ref>".
> 
> The idea and implementation look good to me. Not sure I like the 
> option "bloat" (somehow feels it should be possible to express the same 
> behavior using fewer options), but if there's not a better way to 
> reorganize the options, then you can consider it Acked-by me.

I feel this would be more consistent with most other options that take an optional argument:

  1. "--show-notes" uses default refs

  2. "--show-notes=<ref>" shows _just_ <ref>, no defaults

  3. "--show-notes=<ref1> --show-notes=<ref2>" shows <ref1> and <ref2>

  4. (Probably) "--show-notes --show-notes=<ref>" should show default
     refs and <ref>. This is the one I'm least sure of, as it leaves no
     way to override what came earlier on the command line (which is
     useful if, for example, we end up with Michael's proposed ui.log).
     Perhaps "--no-notes" would reset, so:

       --show-notes --no-notes --show-notes=<ref>

     would be equivalent to:

       --show-notes=<ref>

Of course a total behavior change of what --show-notes currently does.

Speaking of which, it is kind of weird that --show-notes is negated by --no-notes. So maybe it makes sense to introduce "--notes[=<ref>]" to do what I wrote above, and deprecate --show-notes.

-Peff