threads / patch / 40929

patchdocument submodule sync --recursive

Subject: [PATCH] document submodule sync --recursive

## tl;dr

5 messages between Dec 3, 2015 and Dec 4, 2015. Diffs are folded; open one to read it.

replies: 4people: 2as markdown or json

Stefan Beller· Dec 3, 2015, 19:33 UTC · lore
The git-submodule(1) is inconsistent. In the synopsis, it says:
       git submodule [--quiet] sync [--recursive] [--] [<path>...]

The description of the sync does not mention --recursive, and the description of --recursive says that it is only available for foreach, update and status.

The option appears to work, so the documentation should be updated.

Tested-by: Per Cederqvist <cederp@opera.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
---
 This applies on origin/master.
 
 Thanks Per for reporting,
 Stefan
 Documentation/git-submodule.txt | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
Show changes to Documentation/git-submodule.txt +4 −1
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index f17687e..cd8d126 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -237,6 +237,9 @@ sync::
 +
 "git submodule sync" synchronizes all submodules while
 "git submodule sync \-- A" synchronizes submodule "A" only.
++
+If `--recursive` is specified, this command will recurse into the
+registered submodules, and update any nested submodules within.
 
 OPTIONS
 -------
@@ -364,7 +367,7 @@ the submodule itself.
 for linkgit:git-clone[1]'s `--reference` and `--shared` options carefully.
 
 --recursive::
-	This option is only valid for foreach, update and status commands.
+	This option is only valid for foreach, update, status and sync commands.
 	Traverse submodules recursively. The operation is performed not
 	only in the submodules of the current repo, but also
 	in any nested submodules inside those submodules (and so on).

-- 
2.6.1.255.gcc3df29.dirty
Junio C Hamano· Dec 3, 2015, 20:17 UTC · re: Stefan Beller · lore

Re: [PATCH] document submodule sync --recursive

Stefan Beller <sbeller@google.com> writes:
Show 12 quoted lines
> The git-submodule(1) is inconsistent. In the synopsis, it says:
>
>        git submodule [--quiet] sync [--recursive] [--] [<path>...]
>
> The description of the sync does not mention --recursive, and the
> description of --recursive says that it is only available for foreach,
> update and status.
>
> The option appears to work, so the documentation should be
> updated.
>
> Tested-by: Per Cederqvist <cederp@opera.com>

Isn't this Reported-by? (genuine question; I haven't caught up with my inbox backlog and do not claim having seen everything Per wrote to this list).

> Signed-off-by: Stefan Beller <sbeller@google.com>
> ---
>
>  This applies on origin/master.

Thanks. Should it go to maintenance track (iow, was the feature that wasn't documented already in maint)?

Show 30 quoted lines
>  
>  Thanks Per for reporting,
>  Stefan
>
>  Documentation/git-submodule.txt | 5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
> index f17687e..cd8d126 100644
> --- a/Documentation/git-submodule.txt
> +++ b/Documentation/git-submodule.txt
> @@ -237,6 +237,9 @@ sync::
>  +
>  "git submodule sync" synchronizes all submodules while
>  "git submodule sync \-- A" synchronizes submodule "A" only.
> ++
> +If `--recursive` is specified, this command will recurse into the
> +registered submodules, and update any nested submodules within.
>  
>  OPTIONS
>  -------
> @@ -364,7 +367,7 @@ the submodule itself.
>  for linkgit:git-clone[1]'s `--reference` and `--shared` options carefully.
>  
>  --recursive::
> -	This option is only valid for foreach, update and status commands.
> +	This option is only valid for foreach, update, status and sync commands.
>  	Traverse submodules recursively. The operation is performed not
>  	only in the submodules of the current repo, but also
>  	in any nested submodules inside those submodules (and so on).
Stefan Beller· Dec 3, 2015, 20:22 UTC · re: Junio C Hamano · lore

Re: [PATCH] document submodule sync --recursive

On Thu, Dec 3, 2015 at 12:17 PM, Junio C Hamano <gitster@pobox.com> wrote:
Show 6 quoted lines
>>
>> Tested-by: Per Cederqvist <cederp@opera.com>
>
> Isn't this Reported-by? (genuine question; I haven't caught up with
> my inbox backlog and do not claim having seen everything Per wrote
> to this list).

Per wrote he tested `git submodule sync --recursive` with 2.6.3, so yeah the tested refers to the underlying command, not this patch. So Reported-by is better here.

Show 8 quoted lines
>
>> Signed-off-by: Stefan Beller <sbeller@google.com>
>> ---
>>
>>  This applies on origin/master.
>
> Thanks.  Should it go to maintenance track (iow, was the feature
> that wasn't documented already in maint)?

It was introduced via (82f49f294c, Teach --recursive to submodule sync, 2012-10-26) so I guess maint is fine, too

Show 7 quoted lines
>> @@ -237,6 +237,9 @@ sync::
>>  +
>>  "git submodule sync" synchronizes all submodules while
>>  "git submodule sync \-- A" synchronizes submodule "A" only.
>> ++
>> +If `--recursive` is specified, this command will recurse into the
>> +registered submodules, and update any nested submodules within.
I should have paid more attention here and s/update/sync/.
I'll prepare a resend.
Stefan Beller· Dec 3, 2015, 20:41 UTC · re: Stefan Beller · lore

[PATCHv2] document submodule sync --recursive

The git-submodule(1) is inconsistent. In the synopsis, it says:
       git submodule [--quiet] sync [--recursive] [--] [<path>...]

The description of the sync does not mention --recursive, and the description of --recursive says that it is only available for foreach, update and status.

The option was introduced (82f49f294c, Teach --recursive to submodule sync, 2012-10-26) a while ago, so let's document it, too.

Reported-by: Per Cederqvist <cederp@opera.com>
Signed-off-by: Stefan Beller <sbeller@google.com>
---
 This applies on either origin/master or origin/maint.
 
 Thanks,
 Stefan
 
 Documentation/git-submodule.txt | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)
Show changes to Documentation/git-submodule.txt +4 −1
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index f17687e..1572f05 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -237,6 +237,9 @@ sync::
 +
 "git submodule sync" synchronizes all submodules while
 "git submodule sync \-- A" synchronizes submodule "A" only.
++
+If `--recursive` is specified, this command will recurse into the
+registered submodules, and sync any nested submodules within.
 
 OPTIONS
 -------
@@ -364,7 +367,7 @@ the submodule itself.
 for linkgit:git-clone[1]'s `--reference` and `--shared` options carefully.
 
 --recursive::
-	This option is only valid for foreach, update and status commands.
+	This option is only valid for foreach, update, status and sync commands.
 	Traverse submodules recursively. The operation is performed not
 	only in the submodules of the current repo, but also
 	in any nested submodules inside those submodules (and so on).

-- 
2.6.1.255.gcc3df29.dirty

← back to recent threads