Skip to content

Commit

Permalink
Merge branch 'ml/maint-grep-doc' into maint
Browse files Browse the repository at this point in the history
* ml/maint-grep-doc:
  grep docs: document --no-index option
  grep docs: --cached and <tree>... are incompatible
  grep docs: use AsciiDoc literals consistently
  grep docs: pluralize "Example" section
  • Loading branch information
Junio C Hamano committed Mar 8, 2010
2 parents 57c118c + 2e48fcd commit 193c7aa
Showing 1 changed file with 17 additions and 13 deletions.
30 changes: 17 additions & 13 deletions Documentation/git-grep.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ git-grep - Print lines matching a pattern
SYNOPSIS
--------
[verse]
'git grep' [--cached]
[-a | --text] [-I] [-i | --ignore-case] [-w | --word-regexp]
'git grep' [-a | --text] [-I] [-i | --ignore-case] [-w | --word-regexp]
[-v | --invert-match] [-h|-H] [--full-name]
[-E | --extended-regexp] [-G | --basic-regexp]
[-F | --fixed-strings] [-n]
Expand All @@ -21,7 +20,8 @@ SYNOPSIS
[--color | --no-color]
[-A <post-context>] [-B <pre-context>] [-C <context>]
[-f <file>] [-e] <pattern>
[--and|--or|--not|(|)|-e <pattern>...] [<tree>...]
[--and|--or|--not|(|)|-e <pattern>...]
[--cached | --no-index | <tree>...]
[--] [<pathspec>...]

DESCRIPTION
Expand All @@ -33,8 +33,11 @@ registered in the index file, or blobs in given tree objects.
OPTIONS
-------
--cached::
Instead of searching in the working tree files, check
the blobs registered in the index file.
Instead of searching tracked files in the working tree, search
blobs registered in the index file.

--no-index::
Search files in the current directory, not just those tracked by git.

-a::
--text::
Expand Down Expand Up @@ -98,8 +101,8 @@ OPTIONS
--files-without-match::
Instead of showing every matched line, show only the
names of files that contain (or do not contain) matches.
For better compatibility with 'git diff', --name-only is a
synonym for --files-with-matches.
For better compatibility with 'git diff', `--name-only` is a
synonym for `--files-with-matches`.

-z::
--null::
Expand All @@ -125,7 +128,7 @@ OPTIONS
matches.

-<num>::
A shortcut for specifying -C<num>.
A shortcut for specifying `-C<num>`.

-p::
--show-function::
Expand All @@ -140,7 +143,7 @@ OPTIONS

-e::
The next parameter is the pattern. This option has to be
used for patterns starting with - and should be used in
used for patterns starting with `-` and should be used in
scripts passing user input to grep. Multiple patterns are
combined by 'or'.

Expand All @@ -163,8 +166,9 @@ OPTIONS
Do not output matched lines; instead, exit with status 0 when
there is a match and with non-zero status when there isn't.

`<tree>...`::
Search blobs in the trees for specified patterns.
<tree>...::
Instead of searching tracked files in the working tree, search
blobs in the given trees.

\--::
Signals the end of options; the rest of the parameters
Expand All @@ -174,8 +178,8 @@ OPTIONS
If given, limit the search to paths matching at least one pattern.
Both leading paths match and glob(7) patterns are supported.

Example
-------
Examples
--------

git grep 'time_t' -- '*.[ch]'::
Looks for `time_t` in all tracked .c and .h files in the working
Expand Down

0 comments on commit 193c7aa

Please sign in to comment.