summaryrefslogtreecommitdiff
path: root/Documentation/git-submodule.txt
diff options
context:
space:
mode:
authorBrandon Williams <bmwill@google.com>2016-10-19 20:42:54 (GMT)
committerJunio C Hamano <gitster@pobox.com>2016-10-19 21:58:53 (GMT)
commit15ef78008aa6cdd42dbef3b1bd00ae64e4ab731a (patch)
tree8a1263c82e856f8c201a9c9ac817a80ada4cf444 /Documentation/git-submodule.txt
parent4d7bc52b178bffe9e484c4dcd92d5353e2ce716f (diff)
downloadgit-15ef78008aa6cdd42dbef3b1bd00ae64e4ab731a.zip
git-15ef78008aa6cdd42dbef3b1bd00ae64e4ab731a.tar.gz
git-15ef78008aa6cdd42dbef3b1bd00ae64e4ab731a.tar.bz2
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>
Diffstat (limited to 'Documentation/git-submodule.txt')
-rw-r--r--Documentation/git-submodule.txt4
1 files changed, 3 insertions, 1 deletions
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index bf3bb37..d841573 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -259,7 +259,9 @@ OPTIONS
--branch::
Branch of repository to add as submodule.
The name of the branch is recorded as `submodule.<name>.branch` in
- `.gitmodules` for `update --remote`.
+ `.gitmodules` for `update --remote`. A special value of `.` is used to
+ indicate that the name of the branch in the submodule should be the
+ same name as the current branch in the current repository.
-f::
--force::