aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/git-checkout.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2017-12-06 09:23:35 -0800
committerJunio C Hamano <gitster@pobox.com>2017-12-06 09:23:35 -0800
commit0b75572a1b9f601b751d431faea55f492ea92ac9 (patch)
tree77c08b1f554cedb53a924e6ab0ef23e947469858 /Documentation/git-checkout.txt
parent1a4e40aa5dc16564af879142ba9dfbbb88d1e5ff (diff)
parent57f22bf9979c94f66c3596fb28d0588c1edc2f8d (diff)
downloadgit-0b75572a1b9f601b751d431faea55f492ea92ac9.tar.gz
Merge branch 'sb/submodule-recursive-checkout-detach-head'
"git checkout --recursive" may overwrite and rewind the history of the branch that happens to be checked out in submodule repositories, which might not be desirable. Detach the HEAD but still allow the recursive checkout to succeed in such a case. * sb/submodule-recursive-checkout-detach-head: Documentation/checkout: clarify submodule HEADs to be detached recursive submodules: detach HEAD from new state
Diffstat (limited to 'Documentation/git-checkout.txt')
-rw-r--r--Documentation/git-checkout.txt2
1 files changed, 2 insertions, 0 deletions
diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt
index e108b0f74b..bfa64ca5c9 100644
--- a/Documentation/git-checkout.txt
+++ b/Documentation/git-checkout.txt
@@ -264,6 +264,8 @@ section of linkgit:git-add[1] to learn how to operate the `--patch` mode.
local modifications in a submodule would be overwritten the checkout
will fail unless `-f` is used. If nothing (or --no-recurse-submodules)
is used, the work trees of submodules will not be updated.
+ Just like linkgit:git-submodule[1], this will detach the
+ submodules HEAD.
<branch>::
Branch to checkout; if it refers to a branch (i.e., a name that,