travis-ci: switch to Xcode 10.1 macOS image
[gitweb.git] / Documentation / git-grep.txt
index 71f32f35089241bc452cfdccdc6b3e9a30f95366..84fe236a8ee2fd47814c4c7ee854c47279921169 100644 (file)
@@ -13,12 +13,12 @@ SYNOPSIS
           [-v | --invert-match] [-h|-H] [--full-name]
           [-E | --extended-regexp] [-G | --basic-regexp]
           [-P | --perl-regexp]
-          [-F | --fixed-strings] [-n | --line-number]
+          [-F | --fixed-strings] [-n | --line-number] [--column]
           [-l | --files-with-matches] [-L | --files-without-match]
           [(-O | --open-files-in-pager) [<pager>]]
           [-z | --null]
-          [-c | --count] [--all-match] [-q | --quiet]
-          [--max-depth <depth>]
+          [ -o | --only-matching ] [-c | --count] [--all-match] [-q | --quiet]
+          [--max-depth <depth>] [--[no-]recursive]
           [--color[=<when>] | --no-color]
           [--break] [--heading] [-p | --show-function]
           [-A <post-context>] [-B <pre-context>] [-C <context>]
@@ -44,6 +44,9 @@ CONFIGURATION
 grep.lineNumber::
        If set to true, enable `-n` option by default.
 
+grep.column::
+       If set to true, enable the `--column` option by default.
+
 grep.patternType::
        Set the default matching behavior. Using a value of 'basic', 'extended',
        'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
@@ -95,13 +98,6 @@ OPTIONS
        <tree> option the prefix of all submodule output will be the name of
        the parent project's <tree> object.
 
---parent-basename <basename>::
-       For internal use only.  In order to produce uniform output with the
-       --recurse-submodules option, this option can be used to provide the
-       basename of a parent's <tree> object to a submodule so the submodule
-       can prefix its output with the parent's name rather than the SHA1 of
-       the submodule.
-
 -a::
 --text::
        Process binary files as if they were text.
@@ -123,11 +119,18 @@ OPTIONS
 
 --max-depth <depth>::
        For each <pathspec> given on command line, descend at most <depth>
-       levels of directories. A negative value means no limit.
+       levels of directories. A value of -1 means no limit.
        This option is ignored if <pathspec> contains active wildcards.
        In other words if "a*" matches a directory named "a*",
        "*" is matched literally so --max-depth is still effective.
 
+-r::
+--recursive::
+       Same as `--max-depth=-1`; this is the default.
+
+--no-recursive::
+       Same as `--max-depth=0`.
+
 -w::
 --word-regexp::
        Match the pattern only at word boundary (either begin at the
@@ -161,8 +164,11 @@ OPTIONS
 
 -P::
 --perl-regexp::
-       Use Perl-compatible regexp for patterns. Requires libpcre to be
-       compiled in.
+       Use Perl-compatible regular expressions for patterns.
++
+Support for these types of regular expressions is an optional
+compile-time dependency. If Git wasn't compiled with support for them
+providing this option will cause it to die.
 
 -F::
 --fixed-strings::
@@ -173,6 +179,10 @@ OPTIONS
 --line-number::
        Prefix the line number to matching lines.
 
+--column::
+       Prefix the 1-indexed byte-offset of the first match from the start of the
+       matching line.
+
 -l::
 --files-with-matches::
 --name-only::
@@ -198,6 +208,11 @@ OPTIONS
        Output \0 instead of the character that normally follows a
        file name.
 
+-o::
+--only-matching::
+       Print only the matched (non-empty) parts of a matching line, with each such
+       part on a separate output line.
+
 -c::
 --count::
        Instead of showing every matched line, show the number of
@@ -293,8 +308,11 @@ OPTIONS
 <pathspec>...::
        If given, limit the search to paths matching at least one pattern.
        Both leading paths match and glob(7) patterns are supported.
++
+For more details about the <pathspec> syntax, see the 'pathspec' entry
+in linkgit:gitglossary[7].
 
-Examples
+EXAMPLES
 --------
 
 `git grep 'time_t' -- '*.[ch]'`::
@@ -309,6 +327,9 @@ Examples
        Looks for a line that has `NODE` or `Unexpected` in
        files that have lines that match both.
 
+`git grep solution -- :^Documentation`::
+       Looks for `solution`, excluding files in `Documentation`.
+
 GIT
 ---
 Part of the linkgit:git[1] suite