[PATCH] README: fix path to "gitcvs-migration.txt" and be more consistent

[PATCH] README: fix path to "gitcvs-migration.txt" and be more consistent

[Christian Couder]

Before this patch the README suggested to look at
"Documentation/gittutorial.txt" for the tutorial and to use
"man git-commandname" for documentation of each command.

This was not consistent because the tutorial can also be available with
"man gittutorial" if git is installed, and the documentation for each
command can be available at "Documentation/git-commandname.txt" if git
is not installed.

So this patch tries to be more consistent and also fix the path to
the cvs-migration documentation that changed from
"Documentation/cvs-migration.txt" to "Documentation/gitcvs-migration.txt".

Signed-off-by: Christian Couder <chriscool@tuxfamily.org>
---
 README |   14 +++++++++++---
 1 files changed, 11 insertions(+), 3 deletions(-)

	This comes from this discussion:

	http://thread.gmane.org/gmane.comp.version-control.git/104753/focus=104906

diff --git a/README b/README
index 5fa41b7..c932ab3 100644
--- a/README
+++ b/README
@@ -24,10 +24,18 @@ 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/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.
+Documentation/everyday.txt for a useful minimum set of commands, and
+Documentation/git-commandname.txt for documentation of each command.
+If git has been correctly installed, then the tutorial can also be
+read with "man gittutorial" or "git help tutorial", and the
+documentation of each command with "man git-commandname" or "git help
+commandname".
+
+CVS users may also want to read Documentation/gitcvs-migration.txt
+("man gitcvs-migration" or "git help cvs-migration" if git is
+installed).
 
 Many Git online resources are accessible from http://git.or.cz/
 including full documentation and Git related tools.
-- 
1.6.2.rc1.257.g6c75

Re: [PATCH] README: fix path to "gitcvs-migration.txt" and be more consistent

[Brian Foster]

On Tuesday 24 February 2009 21:16:37 Christian Couder wrote:
>[ ... ]
> diff --git a/README b/README
> index 5fa41b7..c932ab3 100644
> --- a/README
> +++ b/README
> @@ -24,10 +24,18 @@ 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/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.
> +Documentation/everyday.txt for a useful minimum set of commands, and
> +Documentation/git-commandname.txt for documentation of each command.
> +If git has been correctly installed, then the tutorial can also be
> +read with "man gittutorial" or "git help tutorial", and the
> +documentation of each command with "man git-commandname" or "git help
> +commandname".

 seems Ok to me, with a caveat — the information is correct,
 but the presentation has a (very minor!) problem (IM(H?)O).
 I find a bit confusing that whilst you type (e.g.):

    git help tutorial

 you don't type:

    git help commandname

 but (e.g.):

    git help log

 that is, the ‘commandname’ is a placeholder (variable), whilst
 the ‘tutorial’ is a literal (constant).  there doesn't seem to
 be a clear distinction made....?    if a clear distinction is
 to be made, it should be done in a consistent manner throughout
 the README.  however, after a brief glance, there does not seem
 to be any distinction made in the README, so this is minor nit.

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

Re: [PATCH] README: fix path to "gitcvs-migration.txt" and be more consistent

[Junio C Hamano]

Thanks.