[PATCH 3/5] grep docs: describe --no-index further
- From
- Dragan Simic <dsimic@manjaro.org>
- Date
- Mar 18, 2024, 17:03 UTC
- Message-ID
- <3e6136028ca3327b027d57c46fb8155ef3c0d6c5.1710781235.git.dsimic@manjaro.org>
- In-Reply-To
- <cover.1710781235.git.dsimic@manjaro.org>
Describe the dependency between --no-index and either of the --cached and --untracked options, which cannot be used together.
As part of that, shuffle a couple of the options, to make the documentation flow a bit better; it makes more sense to describe first the options that have something in common, and to after that describe an option that has some dependency on the already described options.
Signed-off-by: Dragan Simic <dsimic@manjaro.org> --- Documentation/git-grep.txt | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt index ade69f00ebdd..b377523381bb 100644 --- a/Documentation/git-grep.txt +++ b/Documentation/git-grep.txt @@ -28,7 +28,7 @@ SYNOPSIS [-f <file>] [-e] <pattern> [--and|--or|--not|(|)|-e <pattern>...] [--recurse-submodules] [--parent-basename <basename>] - [ [--[no-]exclude-standard] [--cached | --no-index | --untracked] | <tree>...] + [ [--[no-]exclude-standard] [--cached | --untracked | --no-index] | <tree>...] [--] [<pathspec>...] DESCRIPTION @@ -45,13 +45,15 @@ OPTIONS Instead of searching tracked files in the working tree, search blobs registered in the index file. ---no-index:: - Search files in the current directory that is not managed by Git. - --untracked:: In addition to searching in the tracked files in the working tree, search also in untracked files. +--no-index:: + Search files in the current directory that is not managed by Git. + This option cannot be used together with `--cached` or `--untracked`. + See also `grep.fallbackToNoIndex` in CONFIGURATION below. + --no-exclude-standard:: Also search in ignored files by not honoring the `.gitignore` mechanism. Only useful with `--untracked`.