Re: [PATCH 2/2] git-checkout.txt: clarify that <branch> applies when no path is given.

From: Mike Ralphson <mike.ralphson@gmail.com>
Date: Apr 7, 2009, 09:41 UTC
Message-ID: <e2b179460904070241y493ef876xc628d35b606e4032@mail.gmail.com>
In-Reply-To: <1239050722-1227-2-git-send-email-Matthieu.Moy@imag.fr>

2009/4/6 Matthieu Moy <Matthieu.Moy@imag.fr>:

> Otherwise, the sentence "Defaults to HEAD." can be mis-read to mean
> that "git checkout -- hello.c" checks-out from HEAD.

Show 18 quoted lines

> diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt
> index 0b5485b..58bf508 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 path 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 path are given); may be any object
> +       ID that resolves to a commit.  Defaults to HEAD.
> +

s/path are/paths are/g

Sorry if I come across as picking on your grammar, I think your documentation improvements are very worthwhile.

Mike