[1/2] is unchangd, but [2/2] has some major changes: thanks to inputs from Junio and Phil. The inter-diff for [2/2] follows.
diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt index 765abc5..b61a666 100644 --- a/Documentation/diff-options.txt +++ b/Documentation/diff-options.txt @@ -383,13 +383,13 @@ ifndef::git-format-patch that matches other criteria, nothing is selected. -S<string>:: - Look for commits where the specified string was added or - removed. More precisely, find commits that change the number - of occurrences of the specified string. + Look for commits that change the number of occurrences of the + specified string (i.e. addition/ deletion) in a file. + Intended for the scripter's use. + -It is often useful when you're looking for an exact string (like a -function prototype), and want to know the history of that string since -it first came into being. +It is especially useful when you're looking for an exact block of code +(like a struct), and want to know the history of that block since it +first came into being. -G<regex>:: Grep through the patch text of commits for added/removed lines @@ -419,8 +419,8 @@ information. in <string>. --pickaxe-regex:: - Make the <string> not a plain string but an extended POSIX - regex to match. Implied when using `-G`. + Treat the <string> not as a plain string, but an extended + POSIX regex to match. It is implied when `-G` is used. endif::git-format-patch -O<orderfile>:: diff --git a/Documentation/gitdiffcore.txt b/Documentation/gitdiffcore.txt index 39b9c51..d0f2b91 100644 --- a/Documentation/gitdiffcore.txt +++ b/Documentation/gitdiffcore.txt @@ -223,16 +223,16 @@ diffcore-pickaxe: For Detecting Addition/Deletion of Specified String --------------------------------------------------------------------- There are two kinds of pickaxe: the S kind (corresponding to 'git log --S') and the G kind (corresponding to 'git log -G'). +-S') and the G kind (mnemonic: grep; corresponding to 'git log -G'). The S kind detects filepairs whose "result" side and "origin" side -have different number of occurrences of specified string. While -rename detection works as usual, 'git log -S' cannot omit commits -where a the small string being looked for is moved verbatim from one -file to another (since the number of occurrences of that string -changed in each of those two filepairs). The implementation -essentially runs a count, and is significantly cheaper than the G -kind. +have different number of occurrences of specified string. By +definition, it will not detect in-file moves. Also, when a commit +moves a file wholesale without affecting the string being looked at, +rename detection kicks in as usual, and 'git log -S' omits the commit +(since the number of occurrences of that string didn't change in that +rename-detected filepair). The implementation essentially runs a +count, and is significantly cheaper than the G kind. The G kind detects filepairs whose patch text has an added or a deleted line that matches the given regexp. This means that it can @@ -240,12 +240,16 @@ detect in-file (or what rename-detection considers the same file) moves. The implementation of 'git log -G' runs diff twice and greps, and this can be quite expensive. -A diffcore-pickaxe option worth mentioning: `--pickaxe-all`. When not -in effect, diffcore-pickaxe leaves only such filepairs that touch the -specified string in its output. When in effect, diffcore-pickaxe -leaves all filepairs intact if there is such a filepair, or makes the -output empty otherwise. The latter behavior is designed to make -reviewing of the changes in the context of the whole changeset easier. +When `--pickaxe-regex` is used with `-S`, treat the <string> not as a +plain string, but an extended POSIX regex to match. It is implied +when `-G` is used. + +When `--pickaxe-all` is not in effect, diffcore-pickaxe leaves only +the filepairs that touch the specified string in its output. When in +effect, diffcore-pickaxe leaves all filepairs intact if there is such +a filepair, or makes the output empty otherwise. The latter behavior +is designed to make reviewing of the changes in the context of the +whole changeset easier. diffcore-order: For Sorting the Output Based on Filenames --------------------------------------------------------- Ramkumar Ramachandra (2): diffcore-pickaxe: make error messages more consistent diffcore-pickaxe doc: document -S and -G properly Documentation/diff-options.txt | 37 ++++++++++++++++++++++++++------- Documentation/gitdiffcore.txt | 47 +++++++++++++++++++++++++----------------- diffcore-pickaxe.c | 2 +- 3 files changed, 58 insertions(+), 28 deletions(-) -- 184.108.40.206.432.g070c57d -- To unsubscribe from this list: send the line "unsubscribe git" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html