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>

diff --git a/Documentation/config/grep.txt b/Documentation/config/grep.txt
index e521f20390ceaeab8701dd424f13962c3a439ffa..10041f27b0c8e2d004c388a3fc7956b49c5614e9 100644 (file)
--- a/Documentation/config/grep.txt
+++ b/Documentation/config/grep.txt
@@ -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.

diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt
index 0d0103c780af8c454db02a33c909343fb7bd51be..f64f40e9775a841e1117e033e3303c48ca3ef3f0 100644 (file)
--- a/Documentation/git-grep.txt
+++ b/Documentation/git-grep.txt
@@ -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