mirror/ git
1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-04-28 19:45:10 +02:00
Code

grep docs: describe --recurse-submodules further and improve formatting a bit 

Clarify that --recurse-submodules cannot be used together with --untracked,
and improve the formatting in a couple of places, to make it visually clear
that those are the commands or the names of configuration options.

While there, change a couple of "<tree>" placeholders to "_<tree>_", to help
with an ongoing translation improvement effort. [1]

[1] https://lore.kernel.org/git/CAPig+cQc8W4JOpB+TMP=czketU1U7wcY_x9bsP5T=3-XjGLhRQ@mail.gmail.com/

Signed-off-by: Dragan Simic <dsimic@manjaro.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Dragan Simic 2024-03-25 21:34:52 +01:00 committed by Junio C Hamano
parent 11c821f2f2
commit 4a9357a1ba
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Documentation/config/grep.txt
View File

@ -24,5 +24,5 @@ grep.fullName::
If set to true, enable `--full-name` option by default.
grep.fallbackToNoIndex::
If set to true, fall back to git grep --no-index if git grep
If set to true, fall back to `git grep --no-index` if `git grep`
is executed outside of a git repository. Defaults to false.

10
Documentation/git-grep.txt
View File

@ -64,9 +64,9 @@ OPTIONS
--recurse-submodules::
Recursively search in each submodule that is active and
checked out in the repository. When used in combination with the
<tree> option the prefix of all submodule output will be the name of
the parent project's <tree> object. This option has no effect
if `--no-index` is given.
_<tree>_ option the prefix of all submodule output will be the name of
the parent project's _<tree>_ object. This option cannot be used together
with `--untracked`, and it has no effect if `--no-index` is specified.
-a::
--text::
@ -178,7 +178,7 @@ providing this option will cause it to die.
Use \0 as the delimiter for pathnames in the output, and print
them verbatim. Without this option, pathnames with "unusual"
characters are quoted as explained for the configuration
variable core.quotePath (see linkgit:git-config[1]).
variable `core.quotePath` (see linkgit:git-config[1]).
-o::
--only-matching::
@ -332,7 +332,7 @@ EXAMPLES
NOTES ON THREADS
----------------
The `--threads` option (and the grep.threads configuration) will be ignored when
The `--threads` option (and the `grep.threads` configuration) will be ignored when
`--open-files-in-pager` is used, forcing a single-threaded execution.
When grepping the object store (with `--cached` or giving tree objects), running