Date: Friday June 21, 2002 @ 1:11 Author: cameron Update of /home/netrek/cvsroot/Vanilla In directory swashbuckler.real-time.com:/var/tmp/cvs-serv28354 Modified Files: README.developers Log Message: adjust developers notes **************************************** Index: Vanilla/README.developers diff -u Vanilla/README.developers:1.1 Vanilla/README.developers:1.2 --- Vanilla/README.developers:1.1 Tue Oct 31 22:46:07 2000 +++ Vanilla/README.developers Fri Jun 21 01:11:30 2002 @@ -1,5 +1,5 @@ -$Id: README.developers,v 1.1 2000/11/01 04:46:07 cameron Exp $ +$Id: README.developers,v 1.2 2002/06/21 06:11:30 cameron Exp $ README for developers @@ -16,3 +16,22 @@ use "control-x v =" to produce a diff on that file vs CVS use "etags *.c *.h" to build a tag list of variable names use "meta-." to find a definition of a variable or function + + +Commit messages, ChangeLog, and source comments are for different +audiences. + +Commit messages are for storage in CVS and distribution to the mailing +list. They are used for code review by the other developers. Once +generated in CVS, nobody reads them unless they have to review a change +again. This is where you would put design discussion. + +ChangeLog goes to the end user of the code, the server admins, and to +the release engineer who uses it to form a short list of new features +and changes for the web page. This would often be briefer than the CVS +commit message, but remember it is included in the code review process +anyway, so there is a bit of overlap. ChangeLog is CVS controlled. + +Source comments are for the next person trying to understand the code. + +