Re: [PATCH] tutorial.txt renamed

From: Brian Gernhardt <benji@silverinsanity.com>
Date: Jan 7, 2009, 05:36 UTC
Message-ID: <DA6E1A83-FFBA-46BC-9BCF-ED8A2D8F12E7@silverinsanity.com>
In-Reply-To: <200901070628.38019.chriscool@tuxfamily.org>

On Jan 7, 2009, at 12:28 AM, Christian Couder wrote:

Show 21 quoted lines

> Le mercredi 7 janvier 2009, Joey Hess a écrit :
>> diff --git a/README b/README
>> index 548142c..5fa41b7 100644
>> --- a/README
>> +++ b/README
>> @@ -24,7 +24,7 @@ It was originally written by Linus Torvalds with  
>> help
>> of a group of hackers around the net. It is currently maintained by  
>> Junio
>> C Hamano.
>>
>> Please read the file INSTALL for installation instructions.
>> -See Documentation/tutorial.txt to get started, then see
>> +See Documentation/gittutorial.txt to get started,
>
> "man gittutorial" and "git help tutorial" should work to display the
> tutorial, so perhaps we should advise to use them instead of the  
> source,
> since we are advising to use "man git-commandname" below to get help  
> on
> each command.

This is the README file for the project, so it should advise looking at the Documentation directory as neither the man pages or git command are likely installed at this point.

Show 5 quoted lines

>> CVS users may also want to read Documentation/cvs-migration.txt.
>
> The "cvs-migration.txt" was also renamed "gitcvs-migration.txt". It  
> should
> be available with "man gitcvs-migration" and "git help cvs-migration".

This however is a valid point.

I would also suggest that the patch have a different name, as I expected it to be renaming tutorial.txt and I was going to ask why. Perhaps "README: correct for renamed files"?

~~ Brian G.