Re: [PATCH 2/5] grep docs: describe --recurse-submodules further and improve formatting a bit
- From
Eric Sunshine <sunshine@sunshineco.com>
- Date
- Mar 18, 2024, 20:02 UTC
- Message-ID
- <CAPig+cQc8W4JOpB+TMP=czketU1U7wcY_x9bsP5T=3-XjGLhRQ@mail.gmail.com>
- In-Reply-To
- <784912a8d9156fa00ddee218fd600254d7bab160.1710781235.git.dsimic@manjaro.org>
On Mon, Mar 18, 2024 at 1:04 PM Dragan Simic <dsimic@manjaro.org> wrote:
Show 11 quoted lines
> 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. > > Signed-off-by: Dragan Simic <dsimic@manjaro.org> > --- > diff --git a/Documentation/config/grep.txt b/Documentation/config/grep.txt > @@ -24,5 +24,5 @@ grep.fullName:: > 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`
Good.
Show 7 quoted lines
> diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt > @@ -65,8 +65,8 @@ OPTIONS > <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. > + the parent project's <tree> object. This option cannot be used together > + with `--untracked`, and it has no effect if `--no-index` is specified.
I believe that there is a patch series currently in-flight which is re-styling in-prose <foo> placeholders as _<foo>_, so you may want to make that change as well while you're touching this.