From: Junio C Hamano <gitster@pobox•com>
To: Julian Phillips <julian@quantumfyre•co.uk>
Cc: "Björn Steinbrink" <B.Steinbrink@gmx•de>,
"Florian Weimer" <fw@deneb•enyo.de>,
git@vger•kernel.org
Subject: Re: [PATCH] Documentation/git-checkout: Update summary to reflect current abilities
Date: Mon, 24 Mar 2008 09:49:33 -0700 [thread overview]
Message-ID: <7vbq54vzhe.fsf@gitster.siamese.dyndns.org> (raw)
In-Reply-To: 20080324030946.9328.76091.julian@quantumfyre.co.uk
Julian Phillips <julian@quantumfyre•co.uk> writes:
>> 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
Hmm.
The glossary may be a good place to define what the verb "checkout" means.
I think using that defined word without adding "/update/refresh" to
muddy its meaning would be more appropriate, after we establish what
"checkout" means in the glossary.
So how about saying "Check out a whole branch, or paths to the work tree"
or something like that?
next prev parent reply other threads:[~2008-03-24 16:50 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2008-03-23 17:15 What I miss from Cogito H. Peter Anvin
2008-03-23 17:38 ` Theodore Tso
2008-03-23 17:46 ` H. Peter Anvin
2008-03-27 2:36 ` Petr Baudis
2008-03-23 18:21 ` Luciano Rocha
2008-03-23 19:00 ` Mike Hommey
2008-03-23 19:07 ` Bruce Stephens
2008-03-23 19:07 ` Mike Hommey
2008-03-23 19:14 ` Florian Weimer
2008-03-24 0:16 ` Theodore Tso
2008-03-24 1:40 ` Björn Steinbrink
2008-03-24 2:14 ` Theodore Tso
2008-03-24 2:53 ` Junio C Hamano
2008-03-24 3:06 ` [PATCH] Documentation/git-checkout: Update summary to reflect current abilities Julian Phillips
2008-03-24 16:49 ` Junio C Hamano [this message]
2008-03-24 3:06 ` Julian Phillips
2008-03-24 2:57 ` What I miss from Cogito Björn Steinbrink
2008-03-23 18:31 ` Johannes Schindelin
2008-03-23 18:34 ` Junio C Hamano
2008-03-23 18:58 ` H. Peter Anvin
2008-03-23 18:59 ` Junio C Hamano
2008-03-23 19:16 ` Daniel Barkalow
2008-03-23 19:19 ` H. Peter Anvin
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=7vbq54vzhe.fsf@gitster.siamese.dyndns.org \
--to=gitster@pobox$(echo .)com \
--cc=B.Steinbrink@gmx$(echo .)de \
--cc=fw@deneb$(echo .)enyo.de \
--cc=git@vger$(echo .)kernel.org \
--cc=julian@quantumfyre$(echo .)co.uk \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox