diff options
authorMark Lodato <>2010-02-16 00:25:40 (GMT)
committerJunio C Hamano <>2010-02-17 07:00:35 (GMT)
commit3ac4440801905d11de3ba585c2fe306311db6c45 (patch)
parentef0065034a68edfc0ffed9965bb895073ad710db (diff)
grep documentation: clarify what files match
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 <> Signed-off-by: Junio C Hamano <>
1 files changed, 12 insertions, 5 deletions
diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt
index 8c70020..fa91e8b 100644
--- a/Documentation/git-grep.txt
+++ b/Documentation/git-grep.txt
@@ -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>...]
-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.
@@ -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.
@@ -163,12 +163,19 @@ OPTIONS
Signals the end of options; the rest of the parameters
- are <path> limiters.
+ are <pathspec> limiters.
+ If given, limit the search to paths matching at least one pattern.
+ Both leading paths match and glob(7) patterns are supported.
+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