Update documentation to talk about git instead of CVS
authorMarkus Armbruster <armbru@pond.sub.org>
Fri, 28 Mar 2008 19:42:49 +0000 (20:42 +0100)
committerMarkus Armbruster <armbru@pond.sub.org>
Fri, 28 Mar 2008 19:42:49 +0000 (20:42 +0100)
README
bootstrap
doc/coding
src/client/README

diff --git a/README b/README
index 8ae82e06b7d28dfcb25c4b3d8cde33d4251b39d4..d5d50f9e88dceb95ffc08fe1bdab9c93ceb33d7b 100644 (file)
--- a/README
+++ b/README
@@ -20,8 +20,8 @@ To build the server and set up a game, follow the steps below.
 
     If you downloaded a tarball, unpack it.
 
-    If you're pulling from CVS, check out and run bootstrap.  This
-    requires recent versions of Autoconf and Automake to be installed.
+    If you cloned a git repository, run bootstrap.  This requires
+    recent versions of Autoconf and Automake to be installed.
 
 (2) Building a server
 
index 1a1a3aee4c724bdf7a6b51c059937ade1f837af1..bcfaad6d25f412e0c3904b4425c72b3248cc67f5 100755 (executable)
--- a/bootstrap
+++ b/bootstrap
@@ -1,5 +1,5 @@
 #!/bin/sh -e
-# Run this script after a fresh CVS checkout to bring the source tree
+# Run this script after a fresh git-clone to bring the source tree
 # into a state where you can run configure.
 aclocal -I m4
 autoconf
index 179a96c203dc4711831f3f92bc7d2af7d8d04309..46fea16b4fcf9bdcd93cad5a50ffc92380fcca11 100644 (file)
@@ -422,14 +422,18 @@ There are several ways to access an object in set FOO:
   writebmap() instead.
 
 
-CVS
+git
 ---
 
-Commit related changes together, unrelated changes separately.
+Commit related changes together, unrelated changes separately.  
 
-See chapter Change Logs in the GNU coding standards for guidelines on
-log messages.  Try http://www.gnu.org/prep/standards_40.html#SEC40 or
-search the web for `gnu coding standards change logs'.
+Write meaningfull commit messages.  Start with a single short line
+(ideally less than 50 characters) summarizing the change, followed by
+a blank line and then a more thorough description.
+
+The purpose of the change log is not to explain how the code works;
+that should be done in the source code itself.  It's to explain *why*
+you made the change, and what is affected by it.
 
 Don't change whitespace gratuitiously, say just because your editor
 screws up tabs.  Such changes make it much harder to figure out who
index 7056d62ffc0c467dd19428b48e2f5f02305d5657..3558827f0107da5edeab80092a0d2b4cefabf469 100644 (file)
@@ -12,7 +12,7 @@ the Free Software Foundation; either version 2 of the License (in file
 The client is distributed as part of the complete source tarball and
 as a standalone client tarball.  The instructions below apply to the
 client tarball.  If you got the complete source, as tarball or from
-CVS, refer to ../../README instead.
+a git repository, refer to ../../README instead.
 
 See file `INSTALL' for detailed compilation and installation
 instructions.  Quick guide for the impatient: run configure; make;