From a7cf600abceaf6888ae7cc0f97ec9c1be07e33de Mon Sep 17 00:00:00 2001 From: Markus Armbruster Date: Fri, 28 Mar 2008 20:42:49 +0100 Subject: [PATCH] Update documentation to talk about git instead of CVS --- README | 4 ++-- bootstrap | 2 +- doc/coding | 14 +++++++++----- src/client/README | 2 +- 4 files changed, 13 insertions(+), 9 deletions(-) diff --git a/README b/README index 8ae82e06b..d5d50f9e8 100644 --- 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 diff --git a/bootstrap b/bootstrap index 1a1a3aee4..bcfaad6d2 100755 --- 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 diff --git a/doc/coding b/doc/coding index 179a96c20..46fea16b4 100644 --- a/doc/coding +++ b/doc/coding @@ -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 diff --git a/src/client/README b/src/client/README index 7056d62ff..3558827f0 100644 --- a/src/client/README +++ b/src/client/README @@ -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; -- 2.43.0