git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Christian Couder <chriscool@tuxfamily.org>
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org, Joey Hess <joey@kitenet.net>,
	Brian Foster <brian.foster@innova-card.com>,
	Brian Gernhardt <benji@silverinsanity.com>
Subject: [PATCH] README: fix path to "gitcvs-migration.txt" and be more consistent
Date: Tue, 24 Feb 2009 21:16:37 +0100	[thread overview]
Message-ID: <20090224211637.07d764f5.chriscool@tuxfamily.org> (raw)

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

             reply	other threads:[~2009-02-24 20:18 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-02-24 20:16 Christian Couder [this message]
2009-02-25  9:25 ` [PATCH] README: fix path to "gitcvs-migration.txt" and be more consistent Brian Foster
2009-02-25  9:54 ` Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20090224211637.07d764f5.chriscool@tuxfamily.org \
    --to=chriscool@tuxfamily.org \
    --cc=benji@silverinsanity.com \
    --cc=brian.foster@innova-card.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=joey@kitenet.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).