git-submodule.txt: "--branch <branch>" option defaults to 'master'
authorDenton Liu <liu.denton@gmail.com>
Thu, 7 Feb 2019 10:18:55 +0000 (02:18 -0800)
committerJunio C Hamano <gitster@pobox.com>
Thu, 7 Feb 2019 17:45:50 +0000 (09:45 -0800)
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 <liu.denton@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-submodule.txt
index ba3c4df550acfeb04a0a6b753a778816f031492c..4150148fa3ff5d054037f90d4fc3ecea5dd6d529 100644 (file)
@@ -255,13 +255,14 @@ OPTIONS
        This option is only valid for the deinit command. Unregister all
        submodules in the working tree.
 
        This option is only valid for the deinit command. Unregister all
        submodules in the working tree.
 
--b::
---branch::
+-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
        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'.
 
 -f::
 --force::
 
 -f::
 --force::