From: Heikki Orsila <shdl@zakalwe.fi>
Date: Sun, 31 Aug 2008 23:59:57 GMT
Subject: Re: [PATCH] Correct documentation wording for diff options -S and --pickaxe-all
Message-ID: <20080831235957.GB16289@zakalwe.fi>
In-Reply-To: <7v63pg3h4o.fsf@gitster.siamese.dyndns.org>

On Sun, Aug 31, 2008 at 04:21:43PM -0700, Junio C Hamano wrote:
> Thanks, but if we are doing this, we should reword it to something less
> misleading.  The pickaxe search does not look for changes that contains
> string in the sense people might expect (e.g. "diff -u0 | grep string").
> 
> The machinery looks at the old and new copy, and considers it a match if
> they have different numbers of "string" in them.
> 
> So perhaps something like this
> 
> -S<string>::
> 	Look for differences that changes the number of <string> in the
> 	file.
> 
> --pickaxe-all::
> 	When -S finds a change, show all the changes in that changeset,
>         not just the files for which the number of <string> in them
> 	changes.
> 
> but I am bad at writing, so I'll ask others to come up with a better
> wording.

Perhaps like this:

-S:
"Look for differences that change the number of <string> matches in a file.
In other words, moving the <string> inside a file does not imply a 
match, but adding or removing <string> will."

-- 
Heikki Orsila
heikki.orsila@iki.fi
http://www.iki.fi/shd