mirrors/git
1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-11-01 06:47:52 +01:00
Code Activity

Merge branch 'ml/maint-grep-doc' into maint

Browse source 
* 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
This commit is contained in:
Junio C Hamano 2010-03-08 00:36:01 -08:00
commit 193c7aaf5f
1 changed files with 17 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
Documentation/git-grep.txt
View file

@ -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]
@ -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
@ -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::
@ -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::
@ -125,7 +128,7 @@ OPTIONS
matches.
-<num>::
A shortcut for specifying -C<num>.
A shortcut for specifying `-C<num>`.
-p::
--show-function::
@ -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'.
@ -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
@ -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