--- coderev-0.1/README Sat Aug 23 17:05:39 2008 +++ coderev-0.2/README Sat Aug 23 17:07:26 2008
@@ -17,11 +17,12 @@ == Status == -Basic function is alreay implemented on top of python difflib. +Basic function is already implemented on top of python difflib. == Usage == -Download from http://code.google.com/p/coderev/downloads/list and extract the +Checkout trunk revision http://code.google.com/p/coderev/source/checkout or +download from http://code.google.com/p/coderev/downloads/list and extract the tarball to your disk, there are two tools present for you - codediff.py (to compare files/dirs) and coderev.sh (to generate code review page on your svn work space).
@@ -54,24 +55,28 @@ wrapped for sdiff, default is no line wrapping -y, --yes do not prompt for overwriting - * coderev.sh usage - coderev.sh [-r revsion] [file|subdir ...] + (optional) cp coderevrc.sample ~/.coderevrc, customize your own + cd your-workspace + coderev.sh [-r revsion] [-w width] [file|subdir ...] - `revision' is a revision number, or symbol (PREV, BASE, HEAD), see svn - books for details. Default revision is revision of your working copy - (aka. BASE) + `revision' is a revision number, or symbol (PREV, BASE, HEAD) in svn, + see svn books for details. Default revision is revision of your working + copy + + `width' is a number to make code review pages wrap in specific column Default `subdir' is working dir. Example 1: - coderev.sh bin lib + coderev.sh -w80 bin lib - Generate coderev based on your working copy. If you are working on the - most up-to-date version, this is suggested way (faster). + Generate coderev based on your working copy, web pages wrap in column 80. + If you are working on the most up-to-date version, this is suggested way + (faster). - Example 2: + Example 2 (for SVN): coderev.sh -r HEAD bin lib Generate coderev based on HEAD revision (up-to-date version in repository),