submodules: update documentaion for submodule branches
PATCH 1/1 submodules: update documentaion for submodule branches
Update the documentaion for the the special value . to indicate that it signifies that the tracking branch in the submodule should be the same as the current branch in the superproject.
--- Documentation/git-submodule.txt | 4 +++- Documentation/gitmodules.txt | 7 +++++-- 2 files changed, 8 insertions(+), 3 deletions(-)
Documentation/git-submodule.txt +3 -1
@@ -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::
Documentation/gitmodules.txt +5 -2
@@ -50,8 +50,11 @@ submodule.<name>.update:: submodule.<name>.branch:: A remote branch name for tracking updates in the upstream submodule. - If the option is not specified, it defaults to 'master'. See the - `--remote` documentation in linkgit:git-submodule[1] for details. + If the option is not specified, it defaults to 'master'. 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. See the `--remote` documentation in + linkgit:git-submodule[1] for details. submodule.<name>.fetchRecurseSubmodules:: This option can be used to control recursive fetching of this
Signature · 1 line
2.10.1
Quoted 3 lines · Brandon Williams
Update the documentaion for the the special value
.to indicate that it signifies that the tracking branch in the submodule should be the same as the current branch in the superproject.
For reference of other reviewers:
See 4d7bc52b178bffe9e484c4dcd92d5353e2ce716f
as well as https://gerrit-review.googlesource.com/Documentation/user-submodules.html
Thanks,
Stefan
Quoted 43 lines
Signed-off-by Brandon Williams <[email protected]>--- Documentation/git-submodule.txt | 4 +++- Documentation/gitmodules.txt | 7 +++++-- 2 files changed, 8 insertions(+), 3 deletions(-)Documentation/git-submodule.txt +3
-1@@ -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::Documentation/gitmodules.txt +5
-3@@ -50,8 +50,11 @@ submodule.<name>.update:: submodule.<name>.branch:: A remote branch name for tracking updates in the upstream submodule. - If the option is not specified, it defaults to 'master'. See the - `--remote` documentation in linkgit:git-submodule[1] for details. + If the option is not specified, it defaults to 'master'. 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. See the `--remote` documentation in + linkgit:git-submodule[1] for details. submodule.<name>.fetchRecurseSubmodules:: This option can be used to control recursive fetching of this --2.10.1
Quoted 3 lines · Brandon Williams
Update the documentaion for the the special value
.to indicate that it signifies that the tracking branch in the submodule should be the same as the current branch in the superproject.
Thanks. Will typofix while extending with info supplied by Stefan like so:
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 it signifies that the tracking branch in the submodule should be the same as the current branch in the superproject.
Update the documentation to describe this.
Quoted 8 lines · Junio C Hamano
Quoted 3 lines · Brandon Williams
Update the documentaion for the the special value
.to indicate that it signifies that the tracking branch in the submodule should be the same as the current branch in the superproject.Thanks. Will typofix while extending with info supplied by Stefan like so:
Ugh. Should have proof-read before sending it out.
Quoted 5 lines
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 it signifies that the tracking branch in the submodule should be the same as the current branch in the superproject.
... in .gitmodules file to indicate that the tracking branch in the submodule should be ...
"to indicate that it signifies that" was overly redundant.
Quoted 19 lines · Junio C Hamano
Quoted 8 lines · Junio C Hamano
Quoted 3 lines · Brandon Williams
Update the documentaion for the the special value
.to indicate that it signifies that the tracking branch in the submodule should be the same as the current branch in the superproject.Thanks. Will typofix while extending with info supplied by Stefan like so:
Ugh. Should have proof-read before sending it out.
Quoted 5 lines
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 it signifies that the tracking branch in the submodule should be the same as the current branch in the superproject.
Quoted 4 lines
... in .gitmodules file to indicate that the tracking branch in the submodule should be ...
"to indicate that it signifies that" was overly redundant.
Sorry that seems to have stemed from my poor commit message.
Signature · 1 line
Brandon Williams