[PATCH 1/2] git-checkout.txt: clarify that <branch> applies when no path is given.
- From
Matthieu Moy <matthieu.moy@imag.fr>
- Date
- Apr 7, 2009, 10:20 UTC
- Message-ID
- <1239099643-11959-1-git-send-email-Matthieu.Moy@imag.fr>
- In-Reply-To
- <e2b179460904070241y493ef876xc628d35b606e4032@mail.gmail.com>
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 <Matthieu.Moy@imag.fr> ---
> s/path are/paths are/g
Right.
I'm not 100% sure about "no paths are given" Vs "no path is given", but my understanding of english grammar is that since there could have been several paths, the absence of path is still plural (French would be singular here).
> Sorry if I come across as picking on your grammar, I think your > documentation improvements are very worthwhile.
No harm ;-).
Documentation/git-checkout.txt | 9 +++++++-- 1 files changed, 7 insertions(+), 2 deletions(-)
diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt index 0b5485b..7eafcdf 100644 --- a/Documentation/git-checkout.txt +++ b/Documentation/git-checkout.txt @@ -126,9 +126,14 @@ 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