Skip to content

Commit

Permalink
grep documentation: clarify what files match
Browse files Browse the repository at this point in the history
Clarify that git-grep(1) searches only tracked files, and that each
<pathspec> is a pathspec, as in any other ordinary git commands.

Add an example to show a simple use case for searching all .c and .h
files in the current directory and below.

Signed-off-by: Mark Lodato <lodatom@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Mark Lodato authored and Junio C Hamano committed Feb 17, 2010
1 parent ef00650 commit 3ac4440
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions Documentation/git-grep.txt
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@ SYNOPSIS
[-A <post-context>] [-B <pre-context>] [-C <context>]
[-f <file>] [-e] <pattern>
[--and|--or|--not|(|)|-e <pattern>...] [<tree>...]
[--] [<path>...]
[--] [<pathspec>...]

DESCRIPTION
-----------
Look for specified patterns in the working tree files, blobs
registered in the index file, or given tree objects.
Look for specified patterns in the tracked files in the work tree, blobs
registered in the index file, or blobs in given tree objects.


OPTIONS
Expand All @@ -49,7 +49,7 @@ OPTIONS
Don't match the pattern in binary files.

--max-depth <depth>::
For each pathspec given on command line, descend at most <depth>
For each <pathspec> given on command line, descend at most <depth>
levels of directories. A negative value means no limit.

-w::
Expand Down Expand Up @@ -163,12 +163,19 @@ OPTIONS

\--::
Signals the end of options; the rest of the parameters
are <path> limiters.
are <pathspec> limiters.

<pathspec>...::
If given, limit the search to paths matching at least one pattern.
Both leading paths match and glob(7) patterns are supported.

Example
-------

git grep 'time_t' -- '*.[ch]'::
Looks for `time_t` in all tracked .c and .h files in the working
directory and its subdirectories.

git grep -e \'#define\' --and \( -e MAX_PATH -e PATH_MAX \)::
Looks for a line that has `#define` and either `MAX_PATH` or
`PATH_MAX`.
Expand Down

0 comments on commit 3ac4440

Please sign in to comment.