Changeset 188 for trunk/doc/readme.txt

Timestamp:

Sep 6, 2006, 12:37:54 PM (16 years ago)

Author:

Peter Johansson

Message:

fixes #59 explains how files are parsed. Perhaps some of the information in the readme file should propagate to the Trac page.

File:

• trunk/doc/readme.txt (modified) (4 diffs)

trunk/doc/readme.txt

@@ -2 +2 @@
 
 ======================================================================
-Copyright (C) 2005, 2006 Jari Häkkinen
+Copyright (C) 2005 Jari Häkkinen
+Copyright (C) 2006 Jari Häkkinen, Peter Johansson
 
 This file is part of svndigest, http://lev.thep.lu.se/trac/svndigest
@@ -26 +27 @@
 and calculates developer statistics for all subversion controlled
 entries. The result is written to a sub-directory of a user
-specifiable target directory (defualt is the current working
+specifiable target directory (default is the current working
 directory).
 
@@ -35 +36 @@
 that line.
 
-The statistics calculated is the number of lines contributed from each
-contributing developer in the latest (checked out) revision. Also, the
-number of lines still in use from each revision is calculated.
+For each developer svndigest calculates the number of contributed
+lines in the latest (checked out) revision. By checking when each line
+was last change, for each revision svndigest calculates how many lines
+each developer had contributed that are still in use. svndigest
+separates between different types of lines: line of code, line of
+comment, and empty lines.
+
+The separation between types of lines is designed to support C++ style
+line comments like
+
+// blah blah
+
+with two or more slashes in front of them, and C style block comments like
+
+/*
+ * blah blah
+ */
+
+with zero or more stars at the beginning of every line. A line is
+consider to be a line of code, if it contains non-whitespace
+characters being neither inside a C style block nor after a C++ style
+line comment start ('//'). In case the line is not a line of code, it
+is considered as a line of comment if it contains alphanumeric
+characters (see isalnum). Remaining lines are consider empty, in other
+words, lines like: '////////////' or '/*' are considered as empty.
 
 There are many different types of files and for many file types it
@@ -44 +67 @@
 symbolic links and binary files cannot. svndigest treats binary files
 as zero-line files, whereas symbolic links are treated as one-line
-files. There is a possiblity to exclude files from the statistics, the
+files. There is a possibility to exclude files from the statistics, the
 use of the property svndigest:ignore.