Re: [PATCH 2/5] grep docs: describe --recurse-submodules further and improve formatting a bit

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On 2024-03-18 21:02, Eric Sunshine wrote:
On Mon, Mar 18, 2024 at 1:04 PM Dragan Simic <dsimic@xxxxxxxxxxx> wrote:
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@xxxxxxxxxxx>
---
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.

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.

Thanks for the notice.  I'll add that to the v2 of this series, if
there will be other reasons for the v2.




[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]

  Powered by Linux