Skip to content

Commit

Permalink
doc: add more pointers to gitattributes(5) for userdiff
Browse files Browse the repository at this point in the history
Several Git commands can make use of the builtin userdiff patterns, but
it's not obvious in the documentation. Add pointers to the 'Defining a
custom hunk header' part of gitattributes(5) in the description of the
following options:

- the '--function-context' option of `git diff` and friends
- the '--function-context' option of `git grep`
- the '-L :<funcname>' option of `git log`, `gitk` and `git blame`

In 'git-grep.txt', take the opportunity to use backticks in the
description of '--show-function', and improve the wording of the
desription of '--function-context'.

Signed-off-by: Philippe Blain <[email protected]>
Signed-off-by: Junio C Hamano <[email protected]>
  • Loading branch information
phil-blain authored and gitster committed Nov 1, 2020
1 parent a4514a4 commit 0cce88f
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 4 deletions.
5 changes: 4 additions & 1 deletion Documentation/diff-options.txt
Original file line number Diff line number Diff line change
Expand Up @@ -695,7 +695,10 @@ endif::git-format-patch[]

-W::
--function-context::
Show whole surrounding functions of changes.
Show whole function as context lines for each change.
The function names are determined in the same way as
`git diff` works out patch hunk headers (see 'Defining a
custom hunk-header' in linkgit:gitattributes[5]).

ifndef::git-format-patch[]
ifndef::git-log[]
Expand Down
6 changes: 4 additions & 2 deletions Documentation/git-grep.txt
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ providing this option will cause it to die.
--show-function::
Show the preceding line that contains the function name of
the match, unless the matching line is a function name itself.
The name is determined in the same way as 'git diff' works out
The name is determined in the same way as `git diff` works out
patch hunk headers (see 'Defining a custom hunk-header' in
linkgit:gitattributes[5]).

Expand All @@ -266,7 +266,9 @@ providing this option will cause it to die.
Show the surrounding text from the previous line containing a
function name up to the one before the next function name,
effectively showing the whole function in which the match was
found.
found. The function names are determined in the same way as
`git diff` works out patch hunk headers (see 'Defining a
custom hunk-header' in linkgit:gitattributes[5]).

--threads <num>::
Number of grep worker threads to use.
Expand Down
4 changes: 3 additions & 1 deletion Documentation/line-range-format.txt
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,6 @@ regular expression that denotes the range from the first funcname line
that matches '<funcname>', up to the next funcname line. `:<funcname>`
searches from the end of the previous `-L` range, if any, otherwise
from the start of file. `^:<funcname>` searches from the start of
file.
file. The function names are determined in the same way as `git diff`
works out patch hunk headers (see 'Defining a custom hunk-header'
in linkgit:gitattributes[5]).

0 comments on commit 0cce88f

Please sign in to comment.