diff options
| author | Jeff King <peff@peff.net> | 2009-03-03 10:40:41 -0500 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2009-03-19 02:47:40 -0700 |
| commit | 821d56aa68c38f7390b3171092f7b8b814357194 (patch) | |
| tree | 9148611da967e2aced930d17cb74018e094f321d /Documentation/diff-options.txt | |
| parent | 6f55ee4317681a5639ff364d2f0a352bde064269 (diff) | |
| download | git-821d56aa68c38f7390b3171092f7b8b814357194.tar.gz git-821d56aa68c38f7390b3171092f7b8b814357194.tar.xz | |
doc: clarify how -S works
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>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/diff-options.txt')
| -rw-r--r-- | 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 813a7b11b..9276faeb1 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 |