diff options
| author |  Mark Lodato <lodatom@gmail.com> | 2010-02-15 19:25:40 -0500 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2010-02-16 23:00:35 -0800 |
| commit | 3ac4440801905d11de3ba585c2fe306311db6c45 (patch) | |
| tree | 6689e2364b2d92171e187d2c51f2e136eaa4c1d8 /Documentation/git-grep.txt | |
| parent | fix minor memory leak in get_tree_entry() (diff) | |
| download | tgif-3ac4440801905d11de3ba585c2fe306311db6c45.tar.xz | |
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 <lodatom@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-grep.txt')
| -rw-r--r-- | Documentation/git-grep.txt | 17 |
1 files changed, 12 insertions, 5 deletions
diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt index 8c700200f5..fa91e8bebd 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:: @@ -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`. |