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 <Jens.Lehmann@web.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Jens Lehmann committed Mar 6, 2011 at 23:14 UTC 794a3592ad9d8a9b273f6496052bbcb46b1924ed

2 files changed +18

Documentation/git-fetch.txt

@@ -76,6 +76,15 @@ The `pu` branch will be updated even if it is does not fast-forward,

76 because it is prefixed with a plus sign; `tmp` will not be.

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 +

88 SEE ALSO

89 --------

90 linkgit:git-pull[1]

Documentation/git-pull.txt

@@ -220,6 +220,15 @@ If you tried a pull which resulted in a complex conflicts and

220 would want to start over, you can recover with 'git reset'.

221

222

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 +

232 SEE ALSO

233 --------

234 linkgit:git-fetch[1], linkgit:git-merge[1], linkgit:git-config[1]