From: Junio C Hamano <gitster@pobox.com>
Date: Sun, 7 Mar 2010 20:47:17 +0000 (-0800)
Subject: Merge branch 'ml/maint-grep-doc'
X-Git-Tag: v1.7.1-rc0~81
X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/3fea3139c252298f6d79a405f889f05859b9c47d?ds=inline;hp=-c

Merge branch 'ml/maint-grep-doc'

* 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
---

3fea3139c252298f6d79a405f889f05859b9c47d
diff --combined Documentation/git-grep.txt
index 6305f6d82a,ee506e67f0..4b32322a67
--- a/Documentation/git-grep.txt
+++ b/Documentation/git-grep.txt
@@@ -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]
@@@ -18,10 -17,11 +17,11 @@@
  	   [-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::
@@@ -98,8 -101,8 +101,8 @@@
  --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::
@@@ -111,14 -114,12 +114,14 @@@
  	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`
@@@ -127,7 -128,7 +130,7 @@@
  	matches.
  
  -<num>::
- 	A shortcut for specifying -C<num>.
+ 	A shortcut for specifying `-C<num>`.
  
  -p::
  --show-function::
@@@ -142,7 -143,7 +145,7 @@@
  
  -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'.
  
@@@ -165,8 -166,9 +168,9 @@@
  	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
@@@ -176,8 -178,8 +180,8 @@@
  	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