[PATCH] Documentation/git-checkout: Update summary to reflect current abilities
- From
Julian Phillips <julian@quantumfyre.co.uk>
- Date
- Mar 24, 2008, 03:06 UTC
- Message-ID
- <20080324030946.9328.76091.julian@quantumfyre.co.uk>
- In-Reply-To
- <7vtziw3k9a.fsf@gitster.siamese.dyndns.org>
For a while now, git-checkout has been more powerful than the man-page summary would suggest (the main text does describe the new features), so update the summary to hopefully better reflect the current functionality.
Signed-off-by: Julian Phillips <julian@quantumfyre.co.uk> ---
On Sun, 23 Mar 2008, Junio C Hamano wrote:
Show 16 quoted lines
> Theodore Tso <tytso@MIT.EDU> writes: > >> git-checkout - Checkout and switch to a branch >> >> At the very least, will you admit that the summary in the man page is >> perhaps just a wee bit misleading? > > It's not "wee bit misleading" but it just is outright stale. > > Back then, before people realized the operation "to check out the path out > of index or tree-ish" belongs naturally to a command whose name is > "checkout", "to check out the named branch or a commit" was the only thing > that you could do with the command. The one-line description you quoted > above reflects that history. > > Patches very much welcome; I did not notice it was kept stale.
Something like this perhaps?
Documentation/git-checkout.txt | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-)
diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt index 4014e72..1b8caf1 100644 --- a/Documentation/git-checkout.txt +++ b/Documentation/git-checkout.txt @@ -3,7 +3,7 @@ git-checkout(1) NAME ---- -git-checkout - Checkout and switch to a branch +git-checkout - Checkout/update/refresh items in the working tree SYNOPSIS --------
-- 1.5.4.4