[PATCH v2 0/3] Introduce a --use-index command line argument in git grep
The first round is at $gmane/283619. Thanks to Duy and Eric for the reviews.
I decided to go with Duy's suggestion, introducing a new --use-index option, instead of modifying the behaviour of git grep outside of a git repository, as it seems to be the safer way to go.
Changes since the last version:
01/03: Fix the && chain in this test as well.
03/03:
- Introduced the new --no-index argument
- fixed the test thanks to the suggestion of Eric
- modified the test to use --use-index=optional and added a test that
uses --use-index=never.
- Fixed the if/else statements for the error messages to be more
consistent.
- Added documentation for the new option
Interdiff below:
Show changes to 3 files +105 −24
Documentation/git-grep.txt, builtin/grep.c, t/t7810-grep.sh
diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt
index 4a44d6d..90ff643 100644
--- a/Documentation/git-grep.txt
+++ b/Documentation/git-grep.txt
@@ -25,6 +25,7 @@ SYNOPSIS
[-W | --function-context]
[-f <file>] [-e] <pattern>
[--and|--or|--not|(|)|-e <pattern>...]
+ [--use-index=<always|optional|never>]
[ [--[no-]exclude-standard] [--cached | --no-index | --untracked] | <tree>...]
[--] [<pathspec>...]
@@ -66,6 +67,18 @@ OPTIONS
--no-index::
Search files in the current directory that is not managed by Git.
+--use-index::
+ Set the behavior of git grep when used in- or outside of a git
+ repository. If set to always, the command can only be used
+ inside of a git repository, and will fail if it is used
+ outside of a git repository. If set to never, it will work
+ both inside and outside of a git repository, but will not use
+ any information in the index if used inside of a repository.
+ If set to optional, it will work both inside and outside of a
+ git repository, using the information available in the index
+ if used inside a repository. Always and optional can be
+ overridden by `--no-index`.
+
--untracked::
In addition to searching in the tracked files in the working
tree, search also in untracked files.
diff --git a/builtin/grep.c b/builtin/grep.c
index a886af1..bb2add9 100644
--- a/builtin/grep.c
+++ b/builtin/grep.c
@@ -629,6 +629,7 @@ int cmd_grep(int argc, const char **argv, const char *prefix)
int i;
int dummy;
int no_index = 0;
+ const char *use_index = NULL;
int pattern_type_arg = GREP_PATTERN_TYPE_UNSPECIFIED;
struct option options[] = {
@@ -637,6 +638,8 @@ int cmd_grep(int argc, const char **argv, const char *prefix)
OPT_BIT(0, "no-index", &no_index,
N_("find in contents not managed by git"),
GREP_NO_INDEX_EXPLICIT),
+ OPT_STRING(0, "use-index", &use_index, N_("always|optional|never"),
+ N_("options for using the index")),
OPT_BOOL(0, "untracked", &untracked,
N_("search in both tracked and untracked files")),
OPT_SET_INT(0, "exclude-standard", &opt_exclude,
@@ -759,14 +762,29 @@ int cmd_grep(int argc, const char **argv, const char *prefix)
PARSE_OPT_STOP_AT_NON_OPTION);
grep_commit_pattern_type(pattern_type_arg, &opt);
- if (!no_index && !startup_info->have_repository) {
- int nongit = 0;
+ if (use_index) {
+ if (!strcmp(use_index, "always")) {
+ /* same as git grep without --use-index */
+ } else if (!strcmp(use_index, "optional")) {
+ if (!no_index && !startup_info->have_repository) {
+ int nongit = 0;
- setup_git_directory_gently(&nongit);
- if (nongit)
- no_index = GREP_NO_INDEX_IMPLICIT;
+ setup_git_directory_gently(&nongit);
+ if (nongit)
+ no_index = GREP_NO_INDEX_IMPLICIT;
+ }
+ } else if (!strcmp(use_index, "never")) {
+ no_index = GREP_NO_INDEX_EXPLICIT;
+ } else {
+ die(_("invalid option \"%s\" for --use-index, expecting"
+ " always, optional or never"), use_index);
+ }
}
+ if (!no_index && !startup_info->have_repository)
+ /* die the same way as if we did it at the beginning */
+ setup_git_directory();
+
/*
* skip a -- separator; we know it cannot be
* separating revisions from pathnames if
@@ -881,11 +899,13 @@ int cmd_grep(int argc, const char **argv, const char *prefix)
if (!show_in_pager && !opt.status_only)
setup_pager();
- if (untracked || cached) {
- if (no_index == GREP_NO_INDEX_EXPLICIT)
- die(_("--cached or --untracked cannot be used with --no-index."));
- else if (no_index == GREP_NO_INDEX_IMPLICIT)
- die(_("--cached or --untracked cannot be used outside a git repository."));
+ if (no_index && (untracked || cached)) {
+ if (no_index == GREP_NO_INDEX_IMPLICIT)
+ die(_("--cached or --untracked cannot be used outside "
+ "of a git repository."));
+ else
+ die(_("--cached or --untracked cannot be used with "
+ "--no-index or --no-index=never."));
}
if (no_index || untracked) {
@@ -894,7 +914,8 @@ int cmd_grep(int argc, const char **argv, const char *prefix)
if (no_index == GREP_NO_INDEX_IMPLICIT)
die(_("cannot use revs outside of a git repository."));
else
- die(_("--no-index or --untracked cannot be used with revs."));
+ die(_("--no-index, --use-index=never or "
+ "--untracked cannot be used with revs."));
}
hit = grep_directory(&opt, &pathspec, use_exclude);
} else if (0 <= opt_exclude) {
diff --git a/t/t7810-grep.sh b/t/t7810-grep.sh
index 4ba955d..9776f15 100755
--- a/t/t7810-grep.sh
+++ b/t/t7810-grep.sh
@@ -794,9 +794,11 @@ test_expect_success 'outside of git repository' '
GIT_CEILING_DIRECTORIES="$(pwd)/non" &&
export GIT_CEILING_DIRECTORIES &&
cd non/git &&
+ test_must_fail git grep o &&
git grep --no-index o >../actual.full &&
- test_cmp ../expect.full ../actual.full
+ test_cmp ../expect.full ../actual.full &&
cd sub &&
+ test_must_fail git grep o &&
git grep --no-index o >../../actual.sub &&
test_cmp ../../expect.sub ../../actual.sub
) &&
@@ -806,11 +808,12 @@ test_expect_success 'outside of git repository' '
GIT_CEILING_DIRECTORIES="$(pwd)/non" &&
export GIT_CEILING_DIRECTORIES &&
cd non/git &&
+ test_must_fail git grep o &&
git grep --no-index --exclude-standard o >../actual.full &&
test_cmp ../expect.full ../actual.full &&
{
- echo ".gitignore:.*o*"
+ echo ".gitignore:.*o*" &&
cat ../expect.full
} >../expect.with.ignored &&
git grep --no-index --no-exclude o >../actual.full &&
@@ -818,24 +821,67 @@ test_expect_success 'outside of git repository' '
)
'
-test_expect_success 'outside of git repository without --no-index' '
+test_expect_success 'outside of git repository with --use-index=optional' '
rm -fr non &&
mkdir -p non/git/sub &&
echo hello >non/git/file1 &&
echo world >non/git/sub/file2 &&
- {
- echo file1:hello &&
- echo sub/file2:world
- } >non/expect.full &&
+ cat <<-\EOF >non/expect.full &&
+ file1:hello
+ sub/file2:world
+ EOF
+ echo file2:world >non/expect.sub &&
+ (
+ GIT_CEILING_DIRECTORIES="$(pwd)/non" &&
+ export GIT_CEILING_DIRECTORIES &&
+ cd non/git &&
+ test_must_fail git grep --use-index=always o &&
+ git grep --use-index=optional o >../actual.full &&
+ test_cmp ../expect.full ../actual.full &&
+ cd sub &&
+ test_must_fail git grep --use-index=always o &&
+ git grep --use-index=optional o >../../actual.sub &&
+ test_cmp ../../expect.sub ../../actual.sub
+ ) &&
+
+ echo ".*o*" >non/git/.gitignore &&
+ (
+ GIT_CEILING_DIRECTORIES="$(pwd)/non" &&
+ export GIT_CEILING_DIRECTORIES &&
+ cd non/git &&
+ test_must_fail git grep --use-index=always o &&
+ git grep --use-index=optional --exclude-standard o >../actual.full &&
+ test_cmp ../expect.full ../actual.full &&
+
+ {
+ echo ".gitignore:.*o*" &&
+ cat ../expect.full
+ } >../expect.with.ignored &&
+ git grep --use-index=optional --no-exclude o >../actual.full &&
+ test_cmp ../expect.with.ignored ../actual.full
+ )
+'
+
+test_expect_success 'outside of git repository with --use-index=never' '
+ rm -fr non &&
+ mkdir -p non/git/sub &&
+ echo hello >non/git/file1 &&
+ echo world >non/git/sub/file2 &&
+ cat <<-\EOF >non/expect.full &&
+ file1:hello
+ sub/file2:world
+ EOF
echo file2:world >non/expect.sub &&
(
GIT_CEILING_DIRECTORIES="$(pwd)/non" &&
export GIT_CEILING_DIRECTORIES &&
cd non/git &&
- git grep o >../actual.full &&
- test_cmp ../expect.full ../actual.full
+ test_must_fail git grep --use-index=always o &&
+ git grep --use-index=never o >../actual.full &&
+ test_cmp ../expect.full ../actual.full &&
cd sub &&
- git grep o >../../actual.sub &&
+ test_must_fail git grep --use-index=always o &&
+ git grep --use-index=never o >../../actual.sub &&
test_cmp ../../expect.sub ../../actual.sub
) &&
@@ -844,14 +890,15 @@ test_expect_success 'outside of git repository without --no-index' '
GIT_CEILING_DIRECTORIES="$(pwd)/non" &&
export GIT_CEILING_DIRECTORIES &&
cd non/git &&
- git grep --exclude-standard o >../actual.full &&
+ test_must_fail git grep --use-index=always o &&
+ git grep --use-index=never --exclude-standard o >../actual.full &&
test_cmp ../expect.full ../actual.full &&
{
- echo ".gitignore:.*o*"
+ echo ".gitignore:.*o*" &&
cat ../expect.full
} >../expect.with.ignored &&
- git grep --no-exclude o >../actual.full &&
+ git grep --use-index=never --no-exclude o >../actual.full &&
test_cmp ../expect.with.ignored ../actual.full
)
'
Thomas Gummerer (3):
t7810: correct --no-index test
builtin/grep: rename use_index to no_index
builtin/grep: introduce --use-index argument
Documentation/git-grep.txt | 13 +++++++
builtin/grep.c | 57 +++++++++++++++++++++++------
t/t7810-grep.sh | 90 +++++++++++++++++++++++++++++++++++++++++++---
3 files changed, 146 insertions(+), 14 deletions(-)
--
2.7.0.3.g214d8d0.dirty
Thomas Gummerer
