From: Carl Worth <cworth@cworth.org>
To: Junio C Hamano <junkio@cox.net>
Cc: git@vger.kernel.org
Subject: [PATCH] Mention version 1.5.1 in tutorial and user-manual
Date: Fri, 04 May 2007 11:27:10 -0700 [thread overview]
Message-ID: <87wszola0x.wl%cworth@cworth.org> (raw)
[-- Attachment #1: Type: text/plain, Size: 2045 bytes --]
Most other documentation will frequently be read from an installation
of git so will naturally be associated with the installed version.
But these two documents in particular are often read from web pages
while users are still exploring git. It's important to mention
version 1.5.1 since these documents provide example commands that
won't work with previous versions of git.
---
This really tripped up a recent friend who tried to go through the
tutorial on the web page while following along with a 1.4 version of
git, and got very confused.
There's definitely a bunch more that could be done here, (include a
paragraph explaining which version of git is necessary, mention where
to go to upgrade git, call out particular commands that require
specific versions of git, dynamically generate the version that gets
stuck into the documentation, etc.). But I just went with the most
minimal think I could think of to solve the problem
-Carl
Documentation/tutorial.txt | 4 ++--
Documentation/user-manual.txt | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/Documentation/tutorial.txt b/Documentation/tutorial.txt
index e978562..99efce4 100644
--- a/Documentation/tutorial.txt
+++ b/Documentation/tutorial.txt
@@ -1,5 +1,5 @@
-A tutorial introduction to git
-==============================
+A tutorial introduction to git (for version 1.5.1 or newer)
+===========================================================
This tutorial explains how to import a new project into git, make
changes to it, and share changes with other developers.
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index 9c4c41d..dff438f 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -1,5 +1,5 @@
-Git User's Manual
-_________________
+Git User's Manual (for version 1.5.1 or newer)
+______________________________________________
This manual is designed to be readable by someone with basic unix
command-line skills, but no previous knowledge of git.
--
1.5.1.1.g6aead
[-- Attachment #2: Type: application/pgp-signature, Size: 189 bytes --]
reply other threads:[~2007-05-04 18:27 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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=87wszola0x.wl%cworth@cworth.org \
--to=cworth@cworth.org \
--cc=git@vger.kernel.org \
--cc=junkio@cox.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).