Re: [PATCH 1/2] Documentation/git-checkout.txt: clarify usage

From: Johannes Sixt <j.sixt@viscovery.net>
Date: Dec 17, 2012, 08:59 UTC
Message-ID: <50CEDF0A.7040603@viscovery.net>
In-Reply-To: <7vk3shm5d5.fsf@alter.siamese.dyndns.org>

Am 12/17/2012 9:48, schrieb Junio C Hamano:

> Here is what I tentatively have ...

Thanks!

Show 14 quoted lines

> -'git checkout' [--detach] [<commit>]::
> +'git checkout' --detach [<commit>]::
> +'git checkout' <commit>::
>  
> -	Update the index and working tree to reflect the specified
> -	commit and set HEAD to point directly to <commit> (see
> -	"DETACHED HEAD" section.)  Passing `--detach` forces this
> -	behavior even if <commit> is a branch.
> +	Prepare to work on building new history on top of <commit>,
> +	by detaching HEAD at the commit (see "DETACHED HEAD"
> +	section), and updating the index and the files in the
> +	working tree.  Local modifications to the files in the
> +	working tree are kept, so that they can be committed on the
> +	<branch>.

The last half-sentence should better be removed.

> ++
> +Passing `--detach` forces this behavior even if <commit> is a branch.
>  
>  'git checkout' [-p|--patch] [<tree-ish>] [--] <pathspec>...::

-- Hannes