From: Jeff King <peff@peff.net>
To: Junio C Hamano <gitster@pobox.com>
Cc: "Peter Valdemar Mørch (Lists)" <4ux6as402@sneakemail.com>,
git@vger.kernel.org
Subject: [PATCH] doc: clarify how -S works
Date: Tue, 3 Mar 2009 10:40:41 -0500 [thread overview]
Message-ID: <20090303154041.GA31265@coredump.intra.peff.net> (raw)
In-Reply-To: <20090303152333.GB24593@coredump.intra.peff.net>
The existing text was very vague about what exactly it means
for difference to "contain" a change. This seems to cause
confusion on the mailing list every month or two.
To fix it we:
1. use "introduce or remove an instance of" instead of
"contain"
2. point the user to gitdiffcore(7), which contains a more
complete explanation
Signed-off-by: Jeff King <peff@peff.net>
---
I wonder if "gitdiffcore" is a little scary for new people who just want
to use "-S", but hopefully point (1) above will get rid of most of the
confusion, and those who follow the link want to learn all about diff.
Documentation/diff-options.txt | 5 ++++-
1 files changed, 4 insertions(+), 1 deletions(-)
diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
index 813a7b1..9276fae 100644
--- a/Documentation/diff-options.txt
+++ b/Documentation/diff-options.txt
@@ -176,7 +176,10 @@ override configuration settings.
number.
-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.
--pickaxe-all::
When -S finds a change, show all the changes in that
--
1.6.2.rc2.330.gba39e
next prev parent reply other threads:[~2009-03-03 15:42 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2009-03-03 14:28 git log -Sfoo ignores indentation (whitespace?) changes "Peter Valdemar Mørch (Lists)"
2009-03-03 15:23 ` Jeff King
2009-03-03 15:40 ` Jeff King [this message]
2009-03-03 16:12 ` [PATCH] doc: clarify how -S works John Tapsell
2009-03-03 16:19 ` Jeff King
2009-03-03 16:22 ` John Tapsell
2009-03-03 16:42 ` Junio C Hamano
2009-03-03 17:11 ` Jeff King
2009-03-03 17:39 ` John Tapsell
2009-03-03 17:57 ` Jeff King
2009-03-03 18:24 ` Junio C Hamano
2009-03-03 15:48 ` git log -Sfoo ignores indentation (whitespace?) changes "Peter Valdemar Mørch (Lists)"
2009-03-03 16:03 ` Jeff King
2009-03-03 16:21 ` Junio C Hamano
2009-03-03 16:02 ` Michael J Gruber
2009-03-03 16:25 ` Jeff King
2009-03-03 15:58 ` Junio C Hamano
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=20090303154041.GA31265@coredump.intra.peff.net \
--to=peff@peff.net \
--cc=4ux6as402@sneakemail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/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).