Documentation: describe 'submodule update --remote' use case
Make it clear that there is no implicit floating going on; --remote lets you explicitly integrate the upstream branch in your current HEAD (just like running 'git pull' in the submodule). The only distinction with the current 'git pull' is the config location and setting used for the upstream branch, which is hopefully clear now. Signed-off-by: W. Trevor King <wking@tremily.us> Signed-off-by: Junio C Hamano <gitster@pobox.com>
W. Trevor King committed
Jan 26, 2014 at 12:45 UTC
9937e65d8835ee6c026892de48f993d7a524a00f
1 file changed
+10
Documentation/git-submodule.txt
+10
@@ -299,6 +299,16 @@ In order to ensure a current tracking branch state, `update --remote`
299
fetches the submodule's remote repository before calculating the
300
SHA-1. If you don't want to fetch, you should use `submodule update
301
--remote --no-fetch`.
302
++
303
+Use this option to integrate changes from the upstream subproject with
304
+your submodule's current HEAD. Alternatively, you can run `git pull`
305
+from the submodule, which is equivalent except for the remote branch
306
+name: `update --remote` uses the default upstream repository and
307
+`submodule.<name>.branch`, while `git pull` uses the submodule's
308
+`branch.<name>.merge`. Prefer `submodule.<name>.branch` if you want
309
+to distribute the default upstream branch with the superproject and
310
+`branch.<name>.merge` if you want a more native feel while working in
311
+the submodule itself.
312
313
-N::
314
--no-fetch::