Julian Phillips <julian@xxxxxxxxxxxxxxxxx> writes: >> Theodore Tso <tytso@xxxxxxx> 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? -- To unsubscribe from this list: send the line "unsubscribe git" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
