summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2010-02-21 20:01:06 (GMT)
committerJunio C Hamano <gitster@pobox.com>2010-02-21 20:01:06 (GMT)
commit241b9254e1c8ff071d8054f8b6fbe1883b389d69 (patch)
tree73c6c9da005ffbd2abd2b05f92347fd5c7b0796d
parentcab1b013e6f7cc52806926a792c6798f4c7ac4be (diff)
parent3ac4440801905d11de3ba585c2fe306311db6c45 (diff)
downloadgit-241b9254e1c8ff071d8054f8b6fbe1883b389d69.zip
git-241b9254e1c8ff071d8054f8b6fbe1883b389d69.tar.gz
git-241b9254e1c8ff071d8054f8b6fbe1883b389d69.tar.bz2
Merge branch 'ml/maint-grep-doc'
* ml/maint-grep-doc: grep documentation: clarify what files match
-rw-r--r--Documentation/git-grep.txt17
1 files changed, 12 insertions, 5 deletions
diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt
index e019e76..c44724d 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>...]
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
@@ -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::
@@ -168,12 +168,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`.