path: root/Documentation/git-submodule.txt
diff options
authorDenton Liu <>2019-02-07 10:18:55 (GMT)
committerJunio C Hamano <>2019-02-07 17:45:50 (GMT)
commit7a4bb55f3a47756b5cd9ca2d120c7fe119439e81 (patch)
tree82299314c8f3671ba66d764ea2f1d8e4b5e1e4d4 /Documentation/git-submodule.txt
parentd62dad7a7dca3f6a65162bf0e52cdf6927958e78 (diff)
git-submodule.txt: "--branch <branch>" option defaults to 'master'
This behavior is mentioned in gitmodules.txt but not in git-submodule.txt so we copy the information over so that it is not missed. Also, add the missed argument to the -b/--branch option. Signed-off-by: Denton Liu <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'Documentation/git-submodule.txt')
1 files changed, 4 insertions, 3 deletions
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index ba3c4df..4150148 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -255,13 +255,14 @@ OPTIONS
This option is only valid for the deinit command. Unregister all
submodules in the working tree.
+-b <branch>::
+--branch <branch>::
Branch of repository to add as submodule.
The name of the branch is recorded as `submodule.<name>.branch` in
`.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.
+ same name as the current branch in the current repository. If the
+ option is not specified, it defaults to 'master'.