Re: [PATCH] README: fix path to "gitcvs-migration.txt" and be more consistent
On Tuesday 24 February 2009 21:16:37 Christian Couder wrote:
Show 20 quoted lines
>[ ... ]
> 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