Skip to content

Commit 794a359

Browse files
jlehmanngitster
authored andcommitted
fetch/pull: Describe --recurse-submodule restrictions in the BUGS section
Using the --recurse-submodules option with fetch and pull might not always fetch all the submodule commits the user expects, as this will only work when the submodule is already checked out. Document that and warn that this is expected to change in the future. Signed-off-by: Jens Lehmann <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent e5f522d commit 794a359

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

Documentation/git-fetch.txt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,15 @@ The `pu` branch will be updated even if it is does not fast-forward,
7676
because it is prefixed with a plus sign; `tmp` will not be.
7777

7878

79+
BUGS
80+
----
81+
Using --recurse-submodules can only fetch new commits in already checked
82+
out submodules right now. When e.g. upstream added a new submodule in the
83+
just fetched commits of the superproject the submodule itself can not be
84+
fetched, making it impossible to check out that submodule later without
85+
having to do a fetch again. This is expected to be fixed in a future git
86+
version.
87+
7988
SEE ALSO
8089
--------
8190
linkgit:git-pull[1]

Documentation/git-pull.txt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,15 @@ If you tried a pull which resulted in a complex conflicts and
220220
would want to start over, you can recover with 'git reset'.
221221

222222

223+
BUGS
224+
----
225+
Using --recurse-submodules can only fetch new commits in already checked
226+
out submodules right now. When e.g. upstream added a new submodule in the
227+
just fetched commits of the superproject the submodule itself can not be
228+
fetched, making it impossible to check out that submodule later without
229+
having to do a fetch again. This is expected to be fixed in a future git
230+
version.
231+
223232
SEE ALSO
224233
--------
225234
linkgit:git-fetch[1], linkgit:git-merge[1], linkgit:git-config[1]

0 commit comments

Comments
 (0)