Carl WorthMost 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(-)
Show changes to 2 files +4 −5
Documentation/tutorial.txt, Documentation/user-manual.txt
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