diff options
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/git-grep.txt | 19 |
1 files changed, 15 insertions, 4 deletions
diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt index 2bfd8edbc8..bf4b592f48 100644 --- a/Documentation/git-grep.txt +++ b/Documentation/git-grep.txt @@ -8,7 +8,7 @@ git-grep - print lines matching a pattern SYNOPSIS -------- -'git-grep' [<option>...] <pattern> [<path>...] +'git-grep' [<option>...] [-e] <pattern> [--] [<path>...] DESCRIPTION ----------- @@ -18,13 +18,24 @@ containing a match to the given pattern. OPTIONS ------- +`--`:: + Signals the end of options; the rest of the parameters + are <path> limiters. + <option>...:: Either an option to pass to `grep` or `git-ls-files`. - Some `grep` options, such as `-C` and `-m`, that take - parameters are known to `git-grep`. + + The following are the specific `git-ls-files` options + that may be given: `-o`, `--cached`, `--deleted`, `--others`, + `--killed`, `--ignored`, `--modified`, `--exclude=*`, + `--exclude-from=*`, and `--exclude-per-directory=*`. + + All other options will be passed to `grep`. <pattern>:: - The pattern to look for. + The pattern to look for. The first non option is taken + as the pattern; if your pattern begins with a dash, use + `-e <pattern>`. <path>...:: Optional paths to limit the set of files to be searched; |