]> git.pond.sub.org Git - empserver/blobdiff - doc/coding
Update documentation to talk about git instead of CVS
[empserver] / doc / coding
index cbf1a63008214e5b4c6c8bea5d6bb741d1a8447a..46fea16b4fcf9bdcd93cad5a50ffc92380fcca11 100644 (file)
@@ -334,8 +334,6 @@ FIXME reserved names
 
 FIXME conditional compilation is a last resort
 
-FIXME s_char
-
 
 Robustness
 ----------
@@ -424,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.  
+
+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.
 
-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'.
+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