Merge branch 'ml/maint-grep-doc'
authorJunio C Hamano <gitster@pobox.com>
Sun, 7 Mar 2010 20:47:17 +0000 (12:47 -0800)
committerJunio C Hamano <gitster@pobox.com>
Sun, 7 Mar 2010 20:47:17 +0000 (12:47 -0800)
* 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

1  2 
Documentation/git-grep.txt
index 6305f6d82a52d7d3b9e0aac2b2712a4e91931666,ee506e67f09034591b4cd0215f72f61ff607d128..4b32322a67d9f3de8b555d3d9d03e7ddab14e0a7
@@@ -9,8 -9,7 +9,7 @@@ git-grep - Print lines matching a patte
  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]
           [-z | --null]
           [-c | --count] [--all-match] [-q | --quiet]
           [--max-depth <depth>]
 -         [--color | --no-color]
 +         [--color[=<when>] | --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 +33,11 @@@ registered in the index file, or blobs 
  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::
  --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::
        Instead of showing every matched line, show the number of
        lines that match.
  
 ---color::
 +--color[=<when>]::
        Show colored matches.
 +      The value must be always (the default), never, or auto.
  
  --no-color::
        Turn off match highlighting, even when the configuration file
        gives the default to color output.
 +      Same as `--color=never`.
  
  -[ABC] <context>::
        Show `context` trailing (`A` -- after), or leading (`B`
        matches.
  
  -<num>::
-       A shortcut for specifying -C<num>.
+       A shortcut for specifying `-C<num>`.
  
  -p::
  --show-function::
  
  -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'.
  
        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
        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