source: trunk/doc/readme.txt @ 187

Last change on this file since 187 was 187, checked in by Peter Johansson, 15 years ago

some typos

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 3.0 KB
Line 
1$Id: readme.txt 187 2006-09-06 03:12:29Z peter $
2
3======================================================================
4Copyright (C) 2005, 2006 Jari Häkkinen
5
6This file is part of svndigest, http://lev.thep.lu.se/trac/svndigest
7
8svndigest is free software; you can redistribute it and/or modify it
9under the terms of the GNU General Public License as published by the
10Free Software Foundation; either version 2 of the License, or (at your
11option) any later version.
12
13svndigest is distributed in the hope that it will be useful, but
14WITHOUT ANY WARRANTY; without even the implied warranty of
15MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16General Public License for more details.
17
18You should have received a copy of the GNU General Public License
19along with this program; if not, write to the Free Software
20Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
21USA.
22======================================================================
23
24
25svndigest traverses a directory structure (controlled by subversion)
26and calculates developer statistics for all subversion controlled
27entries. The result is written to a sub-directory of a user
28specifiable target directory (defualt is the current working
29directory).
30
31To understand what statistics is calculated by svndigest this
32definition is needed: The developer who made the latest change to a
33line still in use in the latest revision, is considered as the
34contributor of that line regardless of who actually originally created
35that line.
36
37The statistics calculated is the number of lines contributed from each
38contributing developer in the latest (checked out) revision. Also, the
39number of lines still in use from each revision is calculated.
40
41There are many different types of files and for many file types it
42does not make sense to define lines. Source code, documentation, and
43other human readable files can be treated in single line basis whereas
44symbolic links and binary files cannot. svndigest treats binary files
45as zero-line files, whereas symbolic links are treated as one-line
46files. There is a possiblity to exclude files from the statistics, the
47use of the property svndigest:ignore.
48
49Sometimes large test files and xml files are added to the repository
50that should not really be counted in the statistics. This is solved
51with the svndigest:ignore property. Files with this property are
52excluded from statistics. Setting the svndigest:ignore property to a
53directory will exclude all siblings to that directory from svndigest
54treatment.
55
56svndigest requires the subversion repository to be checked out before
57analysis, i.e., svndigest will not run directly against a repository,
58and up to date with the repository.
59
60
61The current flow of the program is.
62
63i) Check that we are working with a WC in subversion control.
64
65ii) Build the requested directory structure ignoring not subversion
66   controlled items. During the directory structure creation a check
67   is made that the WC is up to date with the repository.
68
69iii) Walk through the directory structure and calculate statistics for
70   each entry.
71
72iv) Create the plots and html presentation.
Note: See TracBrowser for help on using the repository browser.