source: trunk/doc/readme.txt @ 342

Last change on this file since 342 was 342, checked in by Peter Johansson, 14 years ago

adding info on ignoring '.in'

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
  • Property svn:mime-type set to text/x-trac-wiki
File size: 5.2 KB

$Id: readme.txt 342 2007-05-19 11:38:43Z peter $

About svndigest

Svndigest traverses a directory structure (controlled by subversion) and calculates developer statistics for all subversion controlled entries. The result is written to a sub-directory of a user specifiable target directory (default is the current working directory).

Statistics

To understand what statistics is calculated by svndigest this definition is needed: The developer who made the latest change to a line still in use in the latest revision, is considered as the contributor of that line regardless of who actually originally created that line.

For each developer svndigest calculates the number of contributed lines in the latest (checked out) revision. Svndigest calculates for each revision, by checking when each line was last changed, how many lines each developer had contributed at that specific revision and still are in use.

Different linetypes

Svndigest parses each file to detect whether lines are code, comment, or other. Depending on the file name, different parsing modes are used, which means different sets of rules what is code or comment are employed. Common for all modes is that comment blocks are identified by a start code (e.g. '/*' in a C file) and a stop code (e.g. '*/' in a C file). If a line contains alphanumeric characters being outside comment blocks, the line is considered to be code. Otherwise, if the line contains alphanumeric characters inside a comment block, the line is considered to be a line of comment. Otherwise the line is considered to be other. At the time being the following comment identifiers are used:

  • cc-mode
    • files: *.c, *.cc, *.cpp, *.cxx, *.h, *.hh, *.hpp, and *.java
    • identifier: /* <comment> */
    • identifier: <comment> end-of-line
  • m4-mode
    • files: *.ac *.am *.m4
    • identifier: dnl <comment> end-of-line
    • identifier: # <comment> end-of-line
  • shell-mode
    • files: *.sh *.pl *.pm *config bootstrap Makefile
    • identifier: # <comment> end-of-line
  • tex-mode
    • files: *.tex *.m
    • identifier: % <comment> end-of-line
  • jsp-mode
    • files: *.jsp
    • identifier: <!-- <comment> -->
    • identifier: <%-- <comment> --%>
  • sgml-mode
    • files: *.sgml, *.html, *.shtml, *.xml, *.xsl, *.xsd, *.css, and *.rss
    • identifier: <!-- <comment> -->
  • text-mode
    • files: all files not matching any other mode
    • identifier: not applicable. All text is considered comments, i.e., lines are either comments or other

There is one exception to these rules. If the files name ends with .in, the trailing .in is ignored and the file name rules above are applied on the remaining part of the file name. An example is test/test_repo.sh.in that is parsed using the shell-mode rules.

Different file types

There are many different types of files and for many file types it does not make sense to define lines. Source code, documentation, and other human readable files can be treated in single line basis whereas 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 possibility to exclude files from the statistics, the use of the property svndigest:ignore.

Sometimes large test files and XML files are added to the repository that should not really be counted in the statistics. This is solved with the svndigest:ignore property. Files with this property are excluded from statistics. Setting the svndigest:ignore property to a directory will exclude all siblings to that directory from svndigest treatment.

Prerequisites

Svndigest runs against a working copy (WC), i.e., svndigest will not run directly against a repository. Svndigest requires that the WC is pristine before running the analysis, i.e., no files are allowed to be modified. We also recommend that the WC is in synch with the repository. Issue svn update before running svndigest.

Flow of the program

The current flow of the program is.

  • Check that we are working with a WC in subversion control.
  • Build the requested directory structure ignoring not subversion

controlled items. During the directory structure creation a check is made that the WC is up to date with the repository.

  • Walk through the directory structure and calculate statistics for each entry.
  • Create the plots and HTML presentation.

Copyright (C) 2005 Jari Häkkinen
Copyright (C) 2006 Jari Häkkinen, Peter Johansson
Copyright (C) 2007 Peter Johansson
This file is part of svndigest, http://lev.thep.lu.se/trac/svndigest
svndigest is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
svndigest is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
USA.
Note: See TracBrowser for help on using the repository browser.