Documentation/checkout: clarify submodule HEADs to be detached

[thirdparty/git.git] / Documentation / git-checkout.txt

diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt
index d6399c0af86bb84cd86b82500ce706cbcd93cd93..84bd323a0024ed46edc650a7ef2e621e4e7de0bc 100644 (file)
--- a/Documentation/git-checkout.txt
+++ b/Documentation/git-checkout.txt
@@ -262,6 +262,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,