Re: [PATCH] doc: clarify how -S works

From: Jeff King <peff@peff.net>
Date: Mar 3, 2009, 17:11 UTC
Message-ID: <20090303171138.GA454@coredump.intra.peff.net>
In-Reply-To: <7v1vted0d7.fsf@gitster.siamese.dyndns.org>

On Tue, Mar 03, 2009 at 08:42:12AM -0800, Junio C Hamano wrote:

> In retrospect, because --pickaxe was designed primarily for Porcelain use,
> it was a mistake for it to have taken a short-and-sweet -S synonym.

Hmm. I actually like the pickaxe behavior and find it useful for searching. IOW, I consider it a porcelain feature, just perhaps not the one that some people are expecting.

Show 8 quoted lines

> >  -S<string>::
> > -	Look for differences that contain the change in <string>.
> > +	Look for differences that introduce or remove an instance of
> > +	<string>. Note that this is different than the string simply
> > +	appearing in diff output; see the 'pickaxe' entry in
> > +	linkgit:gitdiffcore[7] for more details.
> 
> Look for differences that change the number of occurrences of <string>?

Yes, that is technically correct. I was trying to find a wording that was a little less "this is literally what it does" and more "this is what you might find it useful for".

But I don't care overly much; I just think what was there was quite misleading. And I've already provided my paint color, so feel free to apply mine, use what you wrote above, or whatever. Just don't leave it as-is. ;)

-Peff