[PATCH 10/10] Documentation: Document --function-name usage

2014-03-27 Thread David A. Dalrymple (and Bhushan G. Lodha)
From: Bhushan Lodha  David A. Dalrymple dad-...@mit.edu

Signed-off-by: David Dalrymple (on zayin) davi...@alum.mit.edu
---
 Documentation/diff-options.txt |  9 +
 Documentation/gitdiffcore.txt  | 17 ++---
 2 files changed, 23 insertions(+), 3 deletions(-)

diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
index 9b37b2a..a778dff 100644
--- a/Documentation/diff-options.txt
+++ b/Documentation/diff-options.txt
@@ -427,6 +427,15 @@ information.
 --pickaxe-regex::
Treat the string given to `-S` as an extended POSIX regular
expression to match.
+
+--function-nameregex::
+   Look for differences whose patch text contains hunk headers that match
+   regex. This can be useful to locate changes to a particular function
+   or other semantic element in a program, since hunk headers are intended
+   to indicate the function context (in the sense of
+   `--function-context`) in which the particular change occurs. The
+   function context is determined by the diff driver corresponding to the
+   file in question; see linkgit:gitattributes[7] for details.
 endif::git-format-patch[]
 
 -Oorderfile::
diff --git a/Documentation/gitdiffcore.txt b/Documentation/gitdiffcore.txt
index c8b3e51..b8477ce 100644
--- a/Documentation/gitdiffcore.txt
+++ b/Documentation/gitdiffcore.txt
@@ -222,10 +222,11 @@ version prefixed with '+'.
 diffcore-pickaxe: For Detecting Addition/Deletion of Specified String
 -
 
-This transformation limits the set of filepairs to those that change
+This transformation limits the set of filepairs to those that involve
 specified strings between the preimage and the postimage in a certain
-way.  -Sblock of text and -Gregular expression options are used to
-specify different ways these strings are sought.
+way.  -Sblock of text, -Gregular expression, and
+--function-nameregular expression options are used to specify
+different ways these strings are sought.
 
 -Sblock of text detects filepairs whose preimage and postimage
 have different number of occurrences of the specified block of text.
@@ -251,6 +252,16 @@ criterion in a changeset, the entire changeset is kept.  
This behavior
 is designed to make reviewing changes in the context of the whole
 changeset easier.
 
+--function-nameregular expression detects filepairs whose textual
+diff contains a hunk header that matches the given regular expression.
+The hunk header is generated via the diff driver specified in
+`.gitattributes`, and is intended to reflect the function context
+(in the sense of `--function-context`) in which the change occurs,
+with programming-language-dependent heuristics. As of now, the
+programming language is not auto-detected in any way. Also note that
+hunks whose headers do not match the regular expression are not
+currently filtered out; this is only a filepair filter.
+
 diffcore-order: For Sorting the Output Based on Filenames
 -
 
-- 
1.7.12.4 (Apple Git-37)

--
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


Re: [PATCH 10/10] Documentation: Document --function-name usage

2014-03-27 Thread Eric Sunshine
On Thu, Mar 27, 2014 at 2:50 PM, David A. Dalrymple (and Bhushan G.
Lodha) dad-...@mit.edu wrote:
 From: Bhushan Lodha  David A. Dalrymple dad-...@mit.edu

 Signed-off-by: David Dalrymple (on zayin) davi...@alum.mit.edu
 ---
  Documentation/diff-options.txt |  9 +
  Documentation/gitdiffcore.txt  | 17 ++---
  2 files changed, 23 insertions(+), 3 deletions(-)

 diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
 index 9b37b2a..a778dff 100644
 --- a/Documentation/diff-options.txt
 +++ b/Documentation/diff-options.txt
 @@ -427,6 +427,15 @@ information.
  --pickaxe-regex::
 Treat the string given to `-S` as an extended POSIX regular
 expression to match.
 +
 +--function-nameregex::

Missing '=' before regex. Ditto for the several additional instances
in this patch.

 +   Look for differences whose patch text contains hunk headers that match
 +   regex. This can be useful to locate changes to a particular function
 +   or other semantic element in a program, since hunk headers are 
 intended
 +   to indicate the function context (in the sense of
 +   `--function-context`) in which the particular change occurs. The
 +   function context is determined by the diff driver corresponding to the
 +   file in question; see linkgit:gitattributes[7] for details.
  endif::git-format-patch[]

  -Oorderfile::
 diff --git a/Documentation/gitdiffcore.txt b/Documentation/gitdiffcore.txt
 index c8b3e51..b8477ce 100644
 --- a/Documentation/gitdiffcore.txt
 +++ b/Documentation/gitdiffcore.txt
 @@ -222,10 +222,11 @@ version prefixed with '+'.
  diffcore-pickaxe: For Detecting Addition/Deletion of Specified String
  -

 -This transformation limits the set of filepairs to those that change
 +This transformation limits the set of filepairs to those that involve
  specified strings between the preimage and the postimage in a certain
 -way.  -Sblock of text and -Gregular expression options are used to
 -specify different ways these strings are sought.
 +way.  -Sblock of text, -Gregular expression, and
 +--function-nameregular expression options are used to specify
 +different ways these strings are sought.

  -Sblock of text detects filepairs whose preimage and postimage
  have different number of occurrences of the specified block of text.
 @@ -251,6 +252,16 @@ criterion in a changeset, the entire changeset is kept.  
 This behavior
  is designed to make reviewing changes in the context of the whole
  changeset easier.

 +--function-nameregular expression detects filepairs whose textual
 +diff contains a hunk header that matches the given regular expression.
 +The hunk header is generated via the diff driver specified in
 +`.gitattributes`, and is intended to reflect the function context
 +(in the sense of `--function-context`) in which the change occurs,
 +with programming-language-dependent heuristics. As of now, the
 +programming language is not auto-detected in any way. Also note that
 +hunks whose headers do not match the regular expression are not
 +currently filtered out; this is only a filepair filter.
 +
  diffcore-order: For Sorting the Output Based on Filenames
  -

 --
 1.7.12.4 (Apple Git-37)

 --
 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
--
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