X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=Documentation%2Fgit-grep.txt;h=74102b7944fd7153602ea5d9ae0969c150cd945f;hb=7484529d7f17d5bff1faefb007d604aba12a0e1b;hp=017579348319477c6356fcfce309ce68746d6899;hpb=b12bbd5986e1fae4120d7a415c1271c0273cad7e;p=git.git

diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt
index 01757934..74102b79 100644
--- a/Documentation/git-grep.txt
+++ b/Documentation/git-grep.txt
@@ -3,38 +3,87 @@ git-grep(1)
 
 NAME
 ----
-git-grep - print lines matching a pattern
+git-grep - Print lines matching a pattern
 
 
 SYNOPSIS
 --------
-'git-grep' <option>... <pattern> <path>...
+[verse]
+'git-grep' [--cached]
+	   [-a | --text] [-I] [-i | --ignore-case] [-w | --word-regexp]
+	   [-v | --invert-match]
+	   [-E | --extended-regexp] [-G | --basic-regexp] [-F | --fixed-strings]
+	   [-n] [-l | --files-with-matches] [-L | --files-without-match]
+	   [-c | --count]
+	   [-A <post-context>] [-B <pre-context>] [-C <context>]
+	   [-f <file>] [-e <pattern>]
+	   [<tree>...]
+	   [--] [<path>...]
 
 DESCRIPTION
 -----------
-Searches list of files `git-ls-files` produces for lines
-containing a match to the given pattern.
+Look for specified patterns in the working tree files, blobs
+registered in the index file, or given tree objects.
 
 
 OPTIONS
 -------
-<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`.
+--cached::
+	Instead of searching in the working tree files, check
+	the blobs registerd in the index file.
 
-<pattern>::
-	The pattern to look for.
+-a | --text::
+	Process binary files as if they were text.
 
-<path>...::
+-i | --ignore-case::
+	Ignore case differences between the patterns and the
+	files.
 
-	Optional paths to limit the set of files to be searched;
-	passed to `git-ls-files`.
+-w | --word-regexp::
+	Match the pattern only at word boundary (either begin at the
+	beginning of a line, or preceded by a non-word character; end at
+	the end of a line or followed by a non-word character).
+
+-v | --invert-match::
+	Select non-matching lines.
+
+-E | --extended-regexp | -G | --basic-regexp::
+	Use POSIX extended/basic regexp for patterns.  Default
+	is to use basic regexp.
+
+-n::
+	Prefix the line number to matching lines.
+
+-l | --files-with-matches | -L | --files-without-match::
+	Instead of showing every matched line, show only the
+	names of files that contain (or do not contain) matches.
+
+-c | --count::
+	Instead of showing every matched line, show the number of
+	lines that match.
+
+-[ABC] <context>::
+	Show `context` trailing (`A` -- after), or leading (`B`
+	-- before), or both (`C` -- context) lines, and place a
+	line containing `--` between continguous groups of
+	matches.
+
+-f <file>::
+	Read patterns from <file>, one per line.
+
+`<tree>...`::
+	Search blobs in the trees for specified patterns.
+
+`--`::
+	Signals the end of options; the rest of the parameters
+	are <path> limiters.
 
 
 Author
 ------
-Written by Linus Torvalds <torvalds@osdl.org>
+Originally written by Linus Torvalds <torvalds@osdl.org>, later
+revamped by Junio C Hamano.
+
 
 Documentation
 --------------