tutorial.txt renamed
PATCH 1/1 tutorial.txt renamed
The tutorial.txt file was renamed to gittutorial.txt some time ago, update README.
--- README | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-)
README +1 -1
@@ -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.
Signature · 4 lines
1.5.6.5 -- see shy jo
Quoted 17 lines · Joey Hess
The tutorial.txt file was renamed to gittutorial.txt some time ago, update README.
Signed-off-by Joey Hess <[email protected]>--- README | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-)README +0
-0@@ -24,7 +24,7 @@ It was originally written by Linus Torvalds with helpof a group of hackers around the net. It is currently maintained by Junio C Hamano.
Please read the file INSTALL for installation instructions.
README
Quoted 2 lines
README +1
-1-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.
Quoted 2 lines
then see
Documentation/everyday.txtfor 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".)
Quoted 1 line
and "man git-commandname" for documentation of each command.
Yeah "man git-commandname" and "git help commandname" should work.
Quoted 1 line
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.
Quoted 2 lines
--
1.5.6.5
Quoted 11 lines · Christian Couder
Quoted 10 lines · Joey Hess
README +0
-0@@ -24,7 +24,7 @@ It was originally written by Linus Torvalds withhelp
of a group of hackers around the net. It is currently maintained by Junio
C Hamano.
Quoted 10 lines
README
Quoted 3 lines
Please read the file INSTALL for installation instructions.
README +1
-1-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.
Quoted 5 lines
Quoted 1 line
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.
Quoted 23 lines · Brian Gernhardt
Quoted 11 lines · Christian Couder
Quoted 10 lines · Joey Hess
README +0
-0@@ -24,7 +24,7 @@ It was originally written by Linus Torvalds withhelp
of a group of hackers around the net. It is currently maintained by Junio
C Hamano.Quoted 10 lines
README
Quoted 3 lines
Please read the file INSTALL for installation instructions.
README +1
-1-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.
Quoted 3 lines
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.
Quoted 3 lines · Brian Gernhardt
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).
Quoted 8 lines · On Wednesday 07 January 2009 07:27:13 Junio C Hamano wrote:
Quoted 3 lines · Brian Gernhardt
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-
Signature · 4 lines
“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