diff mbox series

[v2,2/3] grep docs: describe --recurse-submodules further and improve formatting a bit

Message ID cf9d3f4833f121b271fd8aacf4c0e2e4a9920585.1711302588.git.dsimic@manjaro.org (mailing list archive)
State Superseded
Headers show
Series Assorted improvements salvaged from an earlier series | expand

Commit Message

Dragan Simic March 24, 2024, 5:51 p.m. UTC
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>
---

Notes:
    Changes in v2:
        - No changes were introduced
    
    This patch is salvaged from my earlier series, [2] for which it has been
    concluded to be not acceptable for merging, because of possible issues
    with various git scripts. [3]
    
    Compared to the version in the earlier series, this version adds some more
    small formatting improvements of the same kind, and also changes a couple
    of "<tree>" placeholders to "_<tree>_", as suggested by Eric Sunshine. [1]
    
    [2] https://lore.kernel.org/git/cover.1710781235.git.dsimic@manjaro.org/T/#u
    [3] https://lore.kernel.org/git/d8475579f014a90b27efaf6207bc6fb0@manjaro.org/

 Documentation/config/grep.txt |  2 +-
 Documentation/git-grep.txt    | 10 +++++-----
 2 files changed, 6 insertions(+), 6 deletions(-)

Comments

Junio C Hamano March 25, 2024, 7:06 p.m. UTC | #1
Dragan Simic <dsimic@manjaro.org> writes:

> 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]

These are all clear improvements.  Will queue.  Thanks
Dragan Simic March 25, 2024, 7:46 p.m. UTC | #2
On 2024-03-25 20:06, Junio C Hamano wrote:
> Dragan Simic <dsimic@manjaro.org> writes:
> 
>> 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]
> 
> These are all clear improvements.  Will queue.  Thanks

Great, thanks.
diff mbox series

Patch

diff --git a/Documentation/config/grep.txt b/Documentation/config/grep.txt
index e521f20390ce..10041f27b0c8 100644
--- 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 0d0103c780af..f64f40e9775a 100644
--- 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