Code review procedure
=====================

$Id: README.review.txt,v 1.3 2000/12/03 18:48:45 pascal Exp $


How to review code
==================

First check out the file you want to review:

    $ cvs co file.c

Review it. Write comments throughout the code and indicate what you have
done. To make it easy for somebody else to locate your changes, you should
include your initials prefixed by '-' in every comment you write, like '-ph'
or '-esr'.

When you are done, make sure that the code still compiles and that the test
suite runs without errors. Continue reviewing until the code compiles and
runs.

When you are absolutely positively sure that you are done with your review
of the file, add a line to the top of the file stating that you reviewed the
code and when you did it:

    * Reviewed 3-12-2000 ph

Then, commit your changes:

    $ cvs commit file.c -m "Reviewed file.c" 
    
And finally tag the new revision with your initials, the string "_review_"
and a number indicating the number of times you have reviewed that file:

    $ cvs tag file.c ph_review_1
    
 
How to verify someone's reviews
===============================

You can use cvs checkout to checkout only those files tagged with a review
tag. For example, to check out only the first code reviews by Pascal Haakmat
(ph):

    $ cvs co -r ph_review_1 mobilizer

You cannot change any files in a working directory checked out like that! It
just allows you to easily see which files have been reviewed. The best thing
to do therefore is to rename the working directory and do another normal
checkout:

    $ mv mobilizer mobilizer-ph_review_1
    $ cvs co mobilizer

Now you can look in the directory 'mobilizer-ph_review_1' to see which files
have been reviewed, and continue working on them in the directory
'mobilizer'.
