Merge branch 'bw/submodule-branch-dot-doc' into maint

Recent git allows submodule.<name>.branch to use a special token
"." instead of the branch name; the documentation has been updated
to describe it.

* bw/submodule-branch-dot-doc:
  submodules doc: update documentation for "." used for submodule branches
This commit is contained in:
Junio C Hamano 2016-10-28 09:01:19 -07:00
commit c8386962d6
2 changed files with 8 additions and 3 deletions

View file

@ -259,7 +259,9 @@ OPTIONS
--branch:: --branch::
Branch of repository to add as submodule. Branch of repository to add as submodule.
The name of the branch is recorded as `submodule.<name>.branch` in 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:: -f::
--force:: --force::

View file

@ -50,8 +50,11 @@ submodule.<name>.update::
submodule.<name>.branch:: submodule.<name>.branch::
A remote branch name for tracking updates in the upstream submodule. A remote branch name for tracking updates in the upstream submodule.
If the option is not specified, it defaults to 'master'. See the If the option is not specified, it defaults to 'master'. A special
`--remote` documentation in linkgit:git-submodule[1] for details. 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. See the `--remote` documentation in
linkgit:git-submodule[1] for details.
submodule.<name>.fetchRecurseSubmodules:: submodule.<name>.fetchRecurseSubmodules::
This option can be used to control recursive fetching of this This option can be used to control recursive fetching of this