threads / patch / 17032

patchtutorial.txt renamed

Subject: [PATCH] tutorial.txt renamed

## tl;dr

6 messages between Jan 7, 2009 and Jan 8, 2009. Diffs are folded; open one to read it.

replies: 5people: 5as markdown or json

Joey Hess· Jan 7, 2009, 04:23 UTC · lore

The tutorial.txt file was renamed to gittutorial.txt some time ago, update README.

Signed-off-by: Joey Hess <joey@gnu.kitenet.net>
---
 README |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

Show changes to README +1 −1

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, then see
 Documentation/everyday.txt for a useful minimum set of commands,
 and "man git-commandname" for documentation of each command.
 CVS users may also want to read Documentation/cvs-migration.txt.

-- 
1.5.6.5

-- 
see shy jo

Christian Couder· Jan 7, 2009, 05:28 UTC · re: Joey Hess · lore

Re: [PATCH] tutorial.txt renamed

Le mercredi 7 janvier 2009, Joey Hess a écrit :

Show 19 quoted lines

> The tutorial.txt file was renamed to gittutorial.txt some time ago,
> update README.
>
> Signed-off-by: Joey Hess <joey@gnu.kitenet.net>
> ---
>  README |    2 +-
>  1 files changed, 1 insertions(+), 1 deletions(-)
>
> 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.

> then see 
>  Documentation/everyday.txt for a useful minimum set of commands,

(But the everyday.txt file has not been converted to a man page, so we cannot advise to use "man giteveryday".)

>  and "man git-commandname" for documentation of each command.

Yeah "man git-commandname" and "git help commandname" should work.

>  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".

Thanks, Christian.

> --
> 1.5.6.5

Brian Gernhardt· Jan 7, 2009, 05:36 UTC · re: Christian Couder · lore

Re: [PATCH] tutorial.txt renamed

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.

Christian Couder· Jan 7, 2009, 06:07 UTC · re: Brian Gernhardt · lore

Re: [PATCH] tutorial.txt renamed

Le mercredi 7 janvier 2009, Brian Gernhardt a écrit :

Show 26 quoted lines

> On Jan 7, 2009, at 12:28 AM, Christian Couder wrote:
> > 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.

Well, this is debatable, because we first ask the user to read the INSTALL file, and a tutorial for git may not be very usefull if you don't have it installed to try out the tutorial commands.

Regards, Christian.

Junio C Hamano· Jan 7, 2009, 06:27 UTC · re: Brian Gernhardt · lore

Re: [PATCH] tutorial.txt renamed

Brian Gernhardt <benji@silverinsanity.com> writes:

> 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.

I think that is a sane suggestion. It is better to keep the number of prerequisites to the minimum for the user in order to follow README (and INSTALL, of course).

Brian Foster· Jan 8, 2009, 09:21 UTC · re: Junio C Hamano · lore

Re: [PATCH] tutorial.txt renamed

On Wednesday 07 January 2009 07:27:13 Junio C Hamano wrote:

Show 8 quoted lines

> Brian Gernhardt <benji@silverinsanity.com> writes:
> > 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.
> 
> I think that is a sane suggestion.  It is better to keep the number of
> prerequisites to the minimum for the user in order to follow README (and
> INSTALL, of course).

 It is indeed a sane suggestion.  However, there is no (obvious?)
 harm in *also* mentioning that ‘git help tutorial’ should also
 display the tutorial.  Something like “If git has been correctly
 installed, then this tutorial can also be read with the command
 ‘git help tutorial’.”

cheers!
	-blf-

-- 
“How many surrealists does it take to   | Brian Foster
 change a lightbulb? Three. One calms   | somewhere in south of France
 the warthog, and two fill the bathtub  |   Stop E$$o (ExxonMobil)!
 with brightly-coloured machine tools.” |      http://www.stopesso.com