2005-09-13 10:39:15 +08:00
|
|
|
git-grep(1)
|
|
|
|
===========
|
|
|
|
|
|
|
|
NAME
|
|
|
|
----
|
2006-03-10 00:24:37 +08:00
|
|
|
git-grep - Print lines matching a pattern
|
2005-09-13 10:39:15 +08:00
|
|
|
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
--------
|
2006-05-09 04:28:49 +08:00
|
|
|
[verse]
|
2010-02-26 11:40:12 +08:00
|
|
|
'git grep' [-a | --text] [-I] [-i | --ignore-case] [-w | --word-regexp]
|
2006-09-16 09:37:01 +08:00
|
|
|
[-v | --invert-match] [-h|-H] [--full-name]
|
2007-04-27 12:58:58 +08:00
|
|
|
[-E | --extended-regexp] [-G | --basic-regexp]
|
|
|
|
[-F | --fixed-strings] [-n]
|
|
|
|
[-l | --files-with-matches] [-L | --files-without-match]
|
2010-06-13 00:39:46 +08:00
|
|
|
[(-O | --open-files-in-pager) [<pager>]]
|
2008-10-02 00:11:15 +08:00
|
|
|
[-z | --null]
|
2010-01-29 04:33:42 +08:00
|
|
|
[-c | --count] [--all-match] [-q | --quiet]
|
grep: Add --max-depth option.
It is useful to grep directories non-recursively, e.g. when one wants to
look for all files in the toplevel directory, but not in any subdirectory,
or in Documentation/, but not in Documentation/technical/.
This patch adds support for --max-depth <depth> option to git-grep. If it is
given, git-grep descends at most <depth> levels of directories below paths
specified on the command line.
Note that if path specified on command line contains wildcards, this option
makes no sense, e.g.
$ git grep -l --max-depth 0 GNU -- 'contrib/*'
(note the quotes) will search all files in contrib/, even in
subdirectories, because '*' matches all files.
Documentation updates, bash-completion and simple test cases are also
provided.
Signed-off-by: Michał Kiedrowicz <michal.kiedrowicz@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2009-07-23 01:52:15 +08:00
|
|
|
[--max-depth <depth>]
|
Add an optional argument for --color options
Make git-branch, git-show-branch, git-grep, and all the diff-based
programs accept an optional argument <when> for --color. The argument
is a colorbool: "always", "never", or "auto". If no argument is given,
"always" is used; --no-color is an alias for --color=never. This makes
the command-line interface consistent with other GNU tools, such as `ls'
and `grep', and with the git-config color options. Note that, without
an argument, --color and --no-color work exactly as before.
To implement this, two internal changes were made:
1. Allow the first argument of git_config_colorbool() to be NULL,
in which case it returns -1 if the argument isn't "always", "never",
or "auto".
2. Add OPT_COLOR_FLAG(), OPT__COLOR(), and parse_opt_color_flag_cb()
to the option parsing library. The callback uses
git_config_colorbool(), so color.h is now a dependency
of parse-options.c.
Signed-off-by: Mark Lodato <lodatom@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-02-17 12:55:58 +08:00
|
|
|
[--color[=<when>] | --no-color]
|
2006-05-09 04:28:49 +08:00
|
|
|
[-A <post-context>] [-B <pre-context>] [-C <context>]
|
2007-04-27 12:58:58 +08:00
|
|
|
[-f <file>] [-e] <pattern>
|
2010-02-26 11:40:12 +08:00
|
|
|
[--and|--or|--not|(|)|-e <pattern>...]
|
2010-02-26 11:40:13 +08:00
|
|
|
[--cached | --no-index | <tree>...]
|
2010-02-16 08:25:40 +08:00
|
|
|
[--] [<pathspec>...]
|
2005-09-13 10:39:15 +08:00
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
-----------
|
2010-02-16 08:25:40 +08:00
|
|
|
Look for specified patterns in the tracked files in the work tree, blobs
|
|
|
|
registered in the index file, or blobs in given tree objects.
|
2005-09-13 10:39:15 +08:00
|
|
|
|
|
|
|
|
2011-03-31 03:31:05 +08:00
|
|
|
CONFIGURATION
|
|
|
|
-------------
|
|
|
|
|
|
|
|
grep.lineNumber::
|
|
|
|
If set to true, enable '-n' option by default.
|
|
|
|
|
|
|
|
grep.extendedRegexp::
|
|
|
|
If set to true, enable '--extended-regexp' option by default.
|
|
|
|
|
|
|
|
|
2005-09-13 10:39:15 +08:00
|
|
|
OPTIONS
|
|
|
|
-------
|
2006-05-09 04:28:49 +08:00
|
|
|
--cached::
|
2010-02-26 11:40:13 +08:00
|
|
|
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.
|
2006-05-09 04:28:49 +08:00
|
|
|
|
2008-06-08 09:36:09 +08:00
|
|
|
-a::
|
|
|
|
--text::
|
2006-05-09 04:28:49 +08:00
|
|
|
Process binary files as if they were text.
|
|
|
|
|
2008-06-08 09:36:09 +08:00
|
|
|
-i::
|
|
|
|
--ignore-case::
|
2006-05-09 04:28:49 +08:00
|
|
|
Ignore case differences between the patterns and the
|
|
|
|
files.
|
|
|
|
|
2007-04-27 12:58:58 +08:00
|
|
|
-I::
|
|
|
|
Don't match the pattern in binary files.
|
|
|
|
|
grep: Add --max-depth option.
It is useful to grep directories non-recursively, e.g. when one wants to
look for all files in the toplevel directory, but not in any subdirectory,
or in Documentation/, but not in Documentation/technical/.
This patch adds support for --max-depth <depth> option to git-grep. If it is
given, git-grep descends at most <depth> levels of directories below paths
specified on the command line.
Note that if path specified on command line contains wildcards, this option
makes no sense, e.g.
$ git grep -l --max-depth 0 GNU -- 'contrib/*'
(note the quotes) will search all files in contrib/, even in
subdirectories, because '*' matches all files.
Documentation updates, bash-completion and simple test cases are also
provided.
Signed-off-by: Michał Kiedrowicz <michal.kiedrowicz@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2009-07-23 01:52:15 +08:00
|
|
|
--max-depth <depth>::
|
2010-02-16 08:25:40 +08:00
|
|
|
For each <pathspec> given on command line, descend at most <depth>
|
grep: Add --max-depth option.
It is useful to grep directories non-recursively, e.g. when one wants to
look for all files in the toplevel directory, but not in any subdirectory,
or in Documentation/, but not in Documentation/technical/.
This patch adds support for --max-depth <depth> option to git-grep. If it is
given, git-grep descends at most <depth> levels of directories below paths
specified on the command line.
Note that if path specified on command line contains wildcards, this option
makes no sense, e.g.
$ git grep -l --max-depth 0 GNU -- 'contrib/*'
(note the quotes) will search all files in contrib/, even in
subdirectories, because '*' matches all files.
Documentation updates, bash-completion and simple test cases are also
provided.
Signed-off-by: Michał Kiedrowicz <michal.kiedrowicz@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2009-07-23 01:52:15 +08:00
|
|
|
levels of directories. A negative value means no limit.
|
|
|
|
|
2008-06-08 09:36:09 +08:00
|
|
|
-w::
|
|
|
|
--word-regexp::
|
2006-05-09 04:28:49 +08:00
|
|
|
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).
|
|
|
|
|
2008-06-08 09:36:09 +08:00
|
|
|
-v::
|
|
|
|
--invert-match::
|
2006-05-09 04:28:49 +08:00
|
|
|
Select non-matching lines.
|
|
|
|
|
2008-06-08 09:36:09 +08:00
|
|
|
-h::
|
|
|
|
-H::
|
2006-09-16 09:37:01 +08:00
|
|
|
By default, the command shows the filename for each
|
|
|
|
match. `-h` option is used to suppress this output.
|
|
|
|
`-H` is there for completeness and does not do anything
|
|
|
|
except it overrides `-h` given earlier on the command
|
|
|
|
line.
|
|
|
|
|
2006-08-11 15:44:42 +08:00
|
|
|
--full-name::
|
|
|
|
When run from a subdirectory, the command usually
|
|
|
|
outputs paths relative to the current directory. This
|
|
|
|
option forces paths to be output relative to the project
|
|
|
|
top directory.
|
|
|
|
|
2008-06-08 09:36:09 +08:00
|
|
|
-E::
|
|
|
|
--extended-regexp::
|
|
|
|
-G::
|
|
|
|
--basic-regexp::
|
2006-05-09 04:28:49 +08:00
|
|
|
Use POSIX extended/basic regexp for patterns. Default
|
|
|
|
is to use basic regexp.
|
2006-01-21 07:00:12 +08:00
|
|
|
|
2008-06-08 09:36:09 +08:00
|
|
|
-F::
|
|
|
|
--fixed-strings::
|
2007-04-27 12:58:58 +08:00
|
|
|
Use fixed strings for patterns (don't interpret pattern
|
|
|
|
as a regex).
|
|
|
|
|
2006-05-09 04:28:49 +08:00
|
|
|
-n::
|
2011-03-29 02:11:55 +08:00
|
|
|
--line-number::
|
2006-05-09 04:28:49 +08:00
|
|
|
Prefix the line number to matching lines.
|
2005-09-13 10:39:15 +08:00
|
|
|
|
2008-06-08 09:36:09 +08:00
|
|
|
-l::
|
|
|
|
--files-with-matches::
|
|
|
|
--name-only::
|
|
|
|
-L::
|
|
|
|
--files-without-match::
|
2006-05-09 04:28:49 +08:00
|
|
|
Instead of showing every matched line, show only the
|
|
|
|
names of files that contain (or do not contain) matches.
|
2010-02-26 11:40:11 +08:00
|
|
|
For better compatibility with 'git diff', `--name-only` is a
|
|
|
|
synonym for `--files-with-matches`.
|
2005-09-13 10:39:15 +08:00
|
|
|
|
2010-06-13 00:39:46 +08:00
|
|
|
-O [<pager>]::
|
|
|
|
--open-files-in-pager [<pager>]::
|
2010-06-13 00:36:51 +08:00
|
|
|
Open the matching files in the pager (not the output of 'grep').
|
|
|
|
If the pager happens to be "less" or "vi", and the user
|
|
|
|
specified only one pattern, the first file is positioned at
|
|
|
|
the first match automatically.
|
|
|
|
|
2008-10-02 00:11:15 +08:00
|
|
|
-z::
|
|
|
|
--null::
|
|
|
|
Output \0 instead of the character that normally follows a
|
|
|
|
file name.
|
|
|
|
|
2008-06-08 09:36:09 +08:00
|
|
|
-c::
|
|
|
|
--count::
|
2006-05-09 04:28:49 +08:00
|
|
|
Instead of showing every matched line, show the number of
|
|
|
|
lines that match.
|
|
|
|
|
Add an optional argument for --color options
Make git-branch, git-show-branch, git-grep, and all the diff-based
programs accept an optional argument <when> for --color. The argument
is a colorbool: "always", "never", or "auto". If no argument is given,
"always" is used; --no-color is an alias for --color=never. This makes
the command-line interface consistent with other GNU tools, such as `ls'
and `grep', and with the git-config color options. Note that, without
an argument, --color and --no-color work exactly as before.
To implement this, two internal changes were made:
1. Allow the first argument of git_config_colorbool() to be NULL,
in which case it returns -1 if the argument isn't "always", "never",
or "auto".
2. Add OPT_COLOR_FLAG(), OPT__COLOR(), and parse_opt_color_flag_cb()
to the option parsing library. The callback uses
git_config_colorbool(), so color.h is now a dependency
of parse-options.c.
Signed-off-by: Mark Lodato <lodatom@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-02-17 12:55:58 +08:00
|
|
|
--color[=<when>]::
|
2009-03-07 20:32:32 +08:00
|
|
|
Show colored matches.
|
Add an optional argument for --color options
Make git-branch, git-show-branch, git-grep, and all the diff-based
programs accept an optional argument <when> for --color. The argument
is a colorbool: "always", "never", or "auto". If no argument is given,
"always" is used; --no-color is an alias for --color=never. This makes
the command-line interface consistent with other GNU tools, such as `ls'
and `grep', and with the git-config color options. Note that, without
an argument, --color and --no-color work exactly as before.
To implement this, two internal changes were made:
1. Allow the first argument of git_config_colorbool() to be NULL,
in which case it returns -1 if the argument isn't "always", "never",
or "auto".
2. Add OPT_COLOR_FLAG(), OPT__COLOR(), and parse_opt_color_flag_cb()
to the option parsing library. The callback uses
git_config_colorbool(), so color.h is now a dependency
of parse-options.c.
Signed-off-by: Mark Lodato <lodatom@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-02-17 12:55:58 +08:00
|
|
|
The value must be always (the default), never, or auto.
|
2009-03-07 20:32:32 +08:00
|
|
|
|
|
|
|
--no-color::
|
|
|
|
Turn off match highlighting, even when the configuration file
|
|
|
|
gives the default to color output.
|
Add an optional argument for --color options
Make git-branch, git-show-branch, git-grep, and all the diff-based
programs accept an optional argument <when> for --color. The argument
is a colorbool: "always", "never", or "auto". If no argument is given,
"always" is used; --no-color is an alias for --color=never. This makes
the command-line interface consistent with other GNU tools, such as `ls'
and `grep', and with the git-config color options. Note that, without
an argument, --color and --no-color work exactly as before.
To implement this, two internal changes were made:
1. Allow the first argument of git_config_colorbool() to be NULL,
in which case it returns -1 if the argument isn't "always", "never",
or "auto".
2. Add OPT_COLOR_FLAG(), OPT__COLOR(), and parse_opt_color_flag_cb()
to the option parsing library. The callback uses
git_config_colorbool(), so color.h is now a dependency
of parse-options.c.
Signed-off-by: Mark Lodato <lodatom@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2010-02-17 12:55:58 +08:00
|
|
|
Same as `--color=never`.
|
2009-03-07 20:32:32 +08:00
|
|
|
|
2006-05-09 04:28:49 +08:00
|
|
|
-[ABC] <context>::
|
|
|
|
Show `context` trailing (`A` -- after), or leading (`B`
|
|
|
|
-- before), or both (`C` -- context) lines, and place a
|
2006-06-04 04:27:26 +08:00
|
|
|
line containing `--` between contiguous groups of
|
2006-05-09 04:28:49 +08:00
|
|
|
matches.
|
|
|
|
|
2007-04-27 12:58:58 +08:00
|
|
|
-<num>::
|
2010-02-26 11:40:11 +08:00
|
|
|
A shortcut for specifying `-C<num>`.
|
2007-04-27 12:58:58 +08:00
|
|
|
|
2009-07-02 06:06:34 +08:00
|
|
|
-p::
|
|
|
|
--show-function::
|
|
|
|
Show the preceding line that contains the function name of
|
|
|
|
the match, unless the matching line is a function name itself.
|
2009-07-02 06:07:24 +08:00
|
|
|
The name is determined in the same way as 'git diff' works out
|
|
|
|
patch hunk headers (see 'Defining a custom hunk-header' in
|
|
|
|
linkgit:gitattributes[5]).
|
2009-07-02 06:06:34 +08:00
|
|
|
|
2006-05-09 04:28:49 +08:00
|
|
|
-f <file>::
|
|
|
|
Read patterns from <file>, one per line.
|
|
|
|
|
2006-06-26 00:07:15 +08:00
|
|
|
-e::
|
|
|
|
The next parameter is the pattern. This option has to be
|
2010-02-26 11:40:11 +08:00
|
|
|
used for patterns starting with `-` and should be used in
|
2006-08-03 06:04:56 +08:00
|
|
|
scripts passing user input to grep. Multiple patterns are
|
|
|
|
combined by 'or'.
|
|
|
|
|
2008-06-08 09:36:09 +08:00
|
|
|
--and::
|
|
|
|
--or::
|
|
|
|
--not::
|
|
|
|
( ... )::
|
2007-01-17 23:32:41 +08:00
|
|
|
Specify how multiple patterns are combined using Boolean
|
2006-08-03 06:04:56 +08:00
|
|
|
expressions. `--or` is the default operator. `--and` has
|
|
|
|
higher precedence than `--or`. `-e` has to be used for all
|
|
|
|
patterns.
|
2006-06-26 00:07:15 +08:00
|
|
|
|
2006-09-28 08:50:52 +08:00
|
|
|
--all-match::
|
|
|
|
When giving multiple pattern expressions combined with `--or`,
|
|
|
|
this flag is specified to limit the match to files that
|
|
|
|
have lines to match all of them.
|
|
|
|
|
2010-01-29 04:33:42 +08:00
|
|
|
-q::
|
|
|
|
--quiet::
|
|
|
|
Do not output matched lines; instead, exit with status 0 when
|
|
|
|
there is a match and with non-zero status when there isn't.
|
|
|
|
|
2010-02-26 11:40:11 +08:00
|
|
|
<tree>...::
|
2010-02-26 11:40:13 +08:00
|
|
|
Instead of searching tracked files in the working tree, search
|
|
|
|
blobs in the given trees.
|
2006-05-09 04:28:49 +08:00
|
|
|
|
2006-08-03 06:04:56 +08:00
|
|
|
\--::
|
2006-05-09 04:28:49 +08:00
|
|
|
Signals the end of options; the rest of the parameters
|
2010-02-16 08:25:40 +08:00
|
|
|
are <pathspec> limiters.
|
2005-09-13 10:39:15 +08:00
|
|
|
|
2010-02-16 08:25:40 +08:00
|
|
|
<pathspec>...::
|
|
|
|
If given, limit the search to paths matching at least one pattern.
|
|
|
|
Both leading paths match and glob(7) patterns are supported.
|
2005-09-13 10:39:15 +08:00
|
|
|
|
2010-02-26 11:40:10 +08:00
|
|
|
Examples
|
|
|
|
--------
|
2006-08-03 06:04:56 +08:00
|
|
|
|
2010-08-20 18:28:53 +08:00
|
|
|
git grep {apostrophe}time_t{apostrophe} \-- {apostrophe}*.[ch]{apostrophe}::
|
2010-02-16 08:25:40 +08:00
|
|
|
Looks for `time_t` in all tracked .c and .h files in the working
|
|
|
|
directory and its subdirectories.
|
|
|
|
|
2010-08-20 18:28:53 +08:00
|
|
|
git grep -e {apostrophe}#define{apostrophe} --and \( -e MAX_PATH -e PATH_MAX \)::
|
2006-08-03 06:04:56 +08:00
|
|
|
Looks for a line that has `#define` and either `MAX_PATH` or
|
|
|
|
`PATH_MAX`.
|
|
|
|
|
2006-09-28 08:50:52 +08:00
|
|
|
git grep --all-match -e NODE -e Unexpected::
|
|
|
|
Looks for a line that has `NODE` or `Unexpected` in
|
|
|
|
files that have lines that match both.
|
|
|
|
|
2005-09-13 10:39:15 +08:00
|
|
|
GIT
|
|
|
|
---
|
2008-06-06 15:07:32 +08:00
|
|
|
Part of the linkgit:git[1] suite
|