summaryrefslogtreecommitdiff
path: root/Documentation/git-submodule.txt
diff options
context:
space:
mode:
authorW. Trevor King <wking@tremily.us>2012-12-19 11:03:33 -0500
committerJunio C Hamano <gitster@pobox.com>2012-12-19 09:40:51 -0800
commitb928922727d6691a3bdc28160f93f25712c565f6 (patch)
tree2030ba639d8a6f5e579e87478ecbbd807074bf6b /Documentation/git-submodule.txt
parent06b1abb5bd38b3cb1972907b059c7f95a197a7a5 (diff)
downloadgit-b928922727d6691a3bdc28160f93f25712c565f6.tar.gz
submodule add: If --branch is given, record it in .gitmodules
This allows you to easily record a submodule.<name>.branch option in .gitmodules when you add a new submodule. With this patch, $ git submodule add -b <branch> <repository> [<path>] $ git config -f .gitmodules submodule.<path>.branch <branch> reduces to $ git submodule add -b <branch> <repository> [<path>] This means that future calls to $ git submodule update --remote ... will get updates from the same branch that you used to initialize the submodule, which is usually what you want. Signed-off-by: W. Trevor King <wking@tremily.us> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-submodule.txt')
-rw-r--r--Documentation/git-submodule.txt2
1 files changed, 2 insertions, 0 deletions
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index 8bf173a906..b1996f1a63 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -208,6 +208,8 @@ OPTIONS
-b::
--branch::
Branch of repository to add as submodule.
+ The name of the branch is recorded as `submodule.<path>.branch` in
+ `.gitmodules` for `update --remote`.
-f::
--force::