submodules doc: update documentation for "." used for submodule branches
4d7bc52b17 ("submodule update: allow '.' for branch value", 2016-08-03) adopted from Gerrit a feature to set "." as a special value of "submodule.<name>.branch" in .gitmodules file to indicate that the tracking branch in the submodule should be the same as the current branch in the superproject. Update the documentation to describe this. Signed-off-by: Brandon Williams <bmwill@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Brandon Williams committed
Oct 19, 2016 at 13:42 UTC
15ef78008aa6cdd42dbef3b1bd00ae64e4ab731a
2 files changed
+8
-3
Documentation/git-submodule.txt
+3
-1
@@ -259,7 +259,9 @@ OPTIONS
259
--branch::
260
Branch of repository to add as submodule.
261
The name of the branch is recorded as `submodule.<name>.branch` in
262
- `.gitmodules` for `update --remote`.
262
+ `.gitmodules` for `update --remote`. A special value of `.` is used to
263
+ indicate that the name of the branch in the submodule should be the
264
+ same name as the current branch in the current repository.
265
266
-f::
267
--force::
Documentation/gitmodules.txt
+5
-2
@@ -50,8 +50,11 @@ submodule.<name>.update::
50
51
submodule.<name>.branch::
52
A remote branch name for tracking updates in the upstream submodule.
53
- If the option is not specified, it defaults to 'master'. See the
54
- `--remote` documentation in linkgit:git-submodule[1] for details.
53
+ If the option is not specified, it defaults to 'master'. A special
54
+ value of `.` is used to indicate that the name of the branch in the
55
+ submodule should be the same name as the current branch in the
56
+ current repository. See the `--remote` documentation in
57
+ linkgit:git-submodule[1] for details.
58
59
submodule.<name>.fetchRecurseSubmodules::
60
This option can be used to control recursive fetching of this