From: Eric Sunshine <sunshine@sunshineco.com>
Date: Fri, 05 Jun 2015 18:37:21 GMT
Subject: Re: Suggestion: make git checkout safer
Message-ID: <CAPig+cTuajnDGdVs18zLd_ngcA=3TZnCn9iNutB9J0FVU1HqrA@mail.gmail.com>
In-Reply-To: <CAPig+cTK4pXgweoGZc1-nj41aYo0bEK6Zrsc9291xQr5v8=p8g@mail.gmail.com>

On Fri, Jun 5, 2015 at 1:44 PM, Eric Sunshine <sunshine@sunshineco.com> wrote:
> On Fri, Jun 5, 2015 at 5:32 AM, Ed Avis <eda@waniasset.com> wrote:
>> Torsten Bögershausen <tboegi <at> web.de> writes:
>>>Do you think you can write a patch to improve the documentation ?
>>
>> Here is my attempt, but it is only a starting point.
>>
>> diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt
>> index d263a56..ee25354 100644
>> --- a/Documentation/git-checkout.txt
>> +++ b/Documentation/git-checkout.txt
>> @@ -3,7 +3,7 @@ git-checkout(1)
>>
>>  NAME
>>  ----
>> -git-checkout - Checkout a branch or paths to the working tree
>> +git-checkout - Overwrite working tree files with a given branch
>
> I agree with Duy's suggestion of "switch branches or reset working

I meant, but forgot to say, that I'd probably replace "reset" with
"restore" in Duy's suggestion.

> tree files" since it explains the high-level purpose of the command,
> whereas your wording gives details of the low-level operation without
> conveying the high-level purpose.