Rename ONE_FILESYSTEM to DISCOVERY_ACROSS_FILESYSTEM

[git.git] / Documentation / git-grep.txt

diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt
index c44724d03a60640d34963f068149a3fe6803d20e..4b32322a67d9f3de8b555d3d9d03e7ddab14e0a7 100644 (file)
--- a/Documentation/git-grep.txt
+++ b/Documentation/git-grep.txt
@@ -9,8 +9,7 @@ git-grep - Print lines matching a pattern
 SYNOPSIS
 --------
 [verse]
 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]
           [-v | --invert-match] [-h|-H] [--full-name]
           [-E | --extended-regexp] [-G | --basic-regexp]
           [-F | --fixed-strings] [-n]


@@ -18,10 +17,11 @@ SYNOPSIS
           [-z | --null]
           [-c | --count] [--all-match] [-q | --quiet]
           [--max-depth <depth>]
           [-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>
           [-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
           [--] [<pathspec>...]
 
 DESCRIPTION


@@ -33,8 +33,11 @@ registered in the index file, or blobs in given tree objects.
 OPTIONS
 -------
 --cached::
 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::
 
 -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.
 --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::
 
 -z::
 --null::


@@ -111,12 +114,14 @@ OPTIONS
        Instead of showing every matched line, show the number of
        lines that match.
 
        Instead of showing every matched line, show the number of
        lines that match.
 

---color::
+--color[=<when>]::

        Show colored matches.
        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.
 
 --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`
 
 -[ABC] <context>::
        Show `context` trailing (`A` -- after), or leading (`B`


@@ -125,7 +130,7 @@ OPTIONS
        matches.
 
 -<num>::
        matches.
 
 -<num>::

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

 
 -p::
 --show-function::
 
 -p::
 --show-function::


@@ -140,7 +145,7 @@ OPTIONS
 
 -e::
        The next parameter is the pattern. This option has to be
 
 -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'.
 
        scripts passing user input to grep.  Multiple patterns are
        combined by 'or'.
 


@@ -163,8 +168,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.
 
        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
 
 \--::
        Signals the end of options; the rest of the parameters


@@ -174,8 +180,8 @@ OPTIONS
        If given, limit the search to paths matching at least one pattern.
        Both leading paths match and glob(7) patterns are supported.
 
        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
 
 git grep 'time_t' -- '*.[ch]'::
        Looks for `time_t` in all tracked .c and .h files in the working