Re: [PATCH 3/4] doc: explain how to deactivate recurse.submodule completely

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

 



Again, the commit title has the option name backwards :
s/recurse.submodule/submodule.recurse/

> Le 28 févr. 2020 à 05:35, Damien Robert <damien.olivier.robert@xxxxxxxxx> a écrit :
> 
> Signed-off-by: Damien Robert <damien.olivier.robert+git@xxxxxxxxx>

I think the commit message for this one could be more detailed 
(even if it would say something very similar to the text added to the doc).
I think it could be made clearer, for example, that the `-c submodule.recurse=0` is
especially useful to deactivate the config when calling commands that do *not* have a `--recurse-submodules` flag,
but that internally call other commands that do support that flag.

> ---
> Documentation/config/submodule.txt | 6 ++++++
> 1 file changed, 6 insertions(+)
> 
> diff --git a/Documentation/config/submodule.txt b/Documentation/config/submodule.txt
> index 5962f41ead..f4edc6cad0 100644
> --- a/Documentation/config/submodule.txt
> +++ b/Documentation/config/submodule.txt
> @@ -62,6 +62,12 @@ submodule.recurse::
> 	applies to all commands that have a `--recurse-submodules` option
> 	(`checkout`, `fetch`, `grep`, `pull`, `push`, `read-tree`, `reset`,
> 	`restore` and `switch`) except `clone` and `ls-files`.
> +	When set to true, it can be deactivated by calling
> +	`--no-recurse-submodules`.

I’d say "can be deactivated for a specific call by adding --no-recurse-submodules."

> But note that since `submodule.recurse`
> +	also applies to internal calls to git commands (issued by other git
> +	commands),

We tend to capitalize "Git" when talking about the system as a whole.

> adding `--no-recurse-submodules` might not be enough to
> +	completely turn off the effect of that config. A solution is to use
> +	`git -c submodule.recurse=0` instead.
> 	Defaults to false.

Personally I’d let "Defaults to false" just after the list of affected commands.

> 
> submodule.fetchJobs::
> -- 
> Patched on top of v2.25.1-377-g2d2118b814 (git version 2.25.1)
> 





[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