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>
Jeff King committed
Mar 3, 2009 at 10:40 UTC
821d56aa68c38f7390b3171092f7b8b814357194
1 file changed
+4
-1
Documentation/diff-options.txt
+4
-1
@@ -176,7 +176,10 @@ override configuration settings.
176
number.
177
178
-S<string>::
179
- Look for differences that contain the change in <string>.
179
+ Look for differences that introduce or remove an instance of
180
+ <string>. Note that this is different than the string simply
181
+ appearing in diff output; see the 'pickaxe' entry in
182
+ linkgit:gitdiffcore[7] for more details.
183
184
--pickaxe-all::
185
When -S finds a change, show all the changes in that