diff mbox series

[1/4] doc: list all commands affected by recurse.submodule

Message ID 20200228103558.1684937-2-damien.olivier.robert+git@gmail.com (mailing list archive)
State New, archived
Headers show
Series doc: --recurse-submodules | expand

Commit Message

Damien Robert Feb. 28, 2020, 10:35 a.m. UTC
Note that `ls-files` is not affected, even though it has a
`--recurse-submodules` option, so list it as an exception too.

Signed-off-by: Damien Robert <damien.olivier.robert+git@gmail.com>
---
 Documentation/config/submodule.txt | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

Comments

Philippe Blain March 2, 2020, 4:43 a.m. UTC | #1
HI Damien,

The commit title has the option name reversed: it’s submodule.recurse and not recurse.submodule

> Le 28 févr. 2020 à 05:35, Damien Robert <damien.olivier.robert@gmail.com> a écrit :
> 
> Note that `ls-files` is not affected, even though it has a
> `--recurse-submodules` option, so list it as an exception too.

Good find.

> 
> Signed-off-by: Damien Robert <damien.olivier.robert+git@gmail.com>
> ---
> Documentation/config/submodule.txt | 5 +++--
> 1 file changed, 3 insertions(+), 2 deletions(-)

I’d also add the same list to the "Implementation details" section of the gitsubmodules guide [1], which just mentions `checkout`
at the moment.

[1] https://git-scm.com/docs/gitsubmodules#_implementation_details

> 
> diff --git a/Documentation/config/submodule.txt b/Documentation/config/submodule.txt
> index b33177151c..5962f41ead 100644
> --- a/Documentation/config/submodule.txt
> +++ b/Documentation/config/submodule.txt
> @@ -59,8 +59,9 @@ submodule.active::
> 
> submodule.recurse::
> 	Specifies if commands recurse into submodules by default. This
> -	applies to all commands that have a `--recurse-submodules` option,
> -	except `clone`.
> +	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`.
> 	Defaults to false.
> 
> submodule.fetchJobs::
> -- 
> Patched on top of v2.25.1-377-g2d2118b814 (git version 2.25.1)
>
Damien Robert March 3, 2020, 5:09 p.m. UTC | #2
From Philippe Blain, Sun 01 Mar 2020 at 23:43:35 (-0500) :
> I’d also add the same list to the "Implementation details" section of the gitsubmodules guide [1], which just mentions `checkout`
> at the moment.

The implementation details section really is about the behaviour of
cloning and checkout. So I just added a link to git-config.
diff mbox series

Patch

diff --git a/Documentation/config/submodule.txt b/Documentation/config/submodule.txt
index b33177151c..5962f41ead 100644
--- a/Documentation/config/submodule.txt
+++ b/Documentation/config/submodule.txt
@@ -59,8 +59,9 @@  submodule.active::
 
 submodule.recurse::
 	Specifies if commands recurse into submodules by default. This
-	applies to all commands that have a `--recurse-submodules` option,
-	except `clone`.
+	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`.
 	Defaults to false.
 
 submodule.fetchJobs::