diff options
| author | Junio C Hamano <junkio@cox.net> | 2006-01-20 15:00:12 -0800 |
|---|---|---|
| committer | Junio C Hamano <junkio@cox.net> | 2006-01-21 19:34:11 -0800 |
| commit | 5b2bcc7b2d546c636f79490655b3347acc91d17f (patch) | |
| tree | e804c0964d6fe495f903eff1cd0acf3bebbf4e91 /Documentation/git-grep.txt | |
| parent | 0bdd79af62e8621359af08f0afca0ce977348ac7 (diff) | |
| download | git-5b2bcc7b2d546c636f79490655b3347acc91d17f.tar.gz | |
git-grep: clarification on parameters.
We forgot to make sure that there is no more than one pattern
parameter. Also when looking for files in a directory called
'--others', it passed that path limiter without preceding the
end-of-options marker '--' to underlying git-ls-files, which
misunderstood it as one of its options instead.
$ git grep --others -e Meta/Make Meta
$ git grep -o -e Meta/Make Meta
$ git grep -o Meta/Make Meta
look for a string "Meta/Make" from untracked files in Meta/
directory.
$ git grep Meta/Make --others
looks for the same string from tracked files in ./--others
directory.
On the other hand,
$ git grep -e Meta/Make --others
does not have a freestanding pattern, so everybody is parameter
and there is no path specifier. It looks for the string in all
the untracked files without any path limiter.
[jc: updated with usability enhancements and documentation
cleanups from Sean.]
Signed-off-by: Junio C Hamano <junkio@cox.net>
Diffstat (limited to 'Documentation/git-grep.txt')
| -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; |