[PATCH v2] git-checkout.txt: clarify that <branch> applies when no path is given.
From: Matthieu Moy <hidden>
Date: 2016-06-15 22:46:34
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
Otherwise, the sentence "Defaults to HEAD." can be mis-read to mean that "git checkout -- hello.c" checks-out from HEAD. Signed-off-by: Matthieu Moy <redacted> --- Sorry, patch v1 was introducing a spurious newline, which broke asciidoc syntax. This fixes it, but Junio, if you already applied v1, just remove the empty line after <branch>:: and before +. Documentation/git-checkout.txt | 8 ++++++-- 1 files changed, 6 insertions(+), 2 deletions(-)
diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt
index 0b5485b..223ea9c 100644
--- a/Documentation/git-checkout.txt
+++ b/Documentation/git-checkout.txt@@ -126,9 +126,13 @@ the conflicted merge in the specified paths. <new_branch>:: Name for the new branch. +<tree-ish>:: + Tree to checkout from (when paths are given). If not specified, + the index will be used. + <branch>:: - Branch to checkout; may be any object ID that resolves to a - commit. Defaults to HEAD. + Branch to checkout (when no paths are given); may be any object + ID that resolves to a commit. Defaults to HEAD. + When this parameter names a non-branch (but still a valid commit object), your HEAD becomes 'detached'.
--
1.6.2.2.449.g92961.dirty