| 1 | $Id: readme.txt 84 2006-03-13 22:04:34Z jari $ |
|---|
| 2 | |
|---|
| 3 | Copyright (C) 2005, 2006 Jari Häkkinen |
|---|
| 4 | |
|---|
| 5 | This file is part of svnstat, http://lev.thep.lu.se/trac/svnstat |
|---|
| 6 | |
|---|
| 7 | svnstat is free software; you can redistribute it and/or modify it |
|---|
| 8 | under the terms of the GNU General Public License as published by the |
|---|
| 9 | Free Software Foundation; either version 2 of the License, or (at your |
|---|
| 10 | option) any later version. |
|---|
| 11 | |
|---|
| 12 | svnstat is distributed in the hope that it will be useful, but WITHOUT |
|---|
| 13 | ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|---|
| 14 | FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|---|
| 15 | for more details. |
|---|
| 16 | |
|---|
| 17 | You should have received a copy of the GNU General Public License |
|---|
| 18 | along with this program; if not, write to the Free Software |
|---|
| 19 | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, |
|---|
| 20 | USA. |
|---|
| 21 | |
|---|
| 22 | |
|---|
| 23 | |
|---|
| 24 | svnstat traverses a directory structure (controlled by subversion) and |
|---|
| 25 | calculates developer statistics for all subversion controlled |
|---|
| 26 | entries. The result is written to a sub-directory, svnstat_output, |
|---|
| 27 | that will be created in the current working directory. |
|---|
| 28 | |
|---|
| 29 | To understand what statistics is calculated by svnstat this definition |
|---|
| 30 | is needed: The developer who made the latest change to a line still in |
|---|
| 31 | use in the latest (checked out) revision, is considered as the |
|---|
| 32 | contributor of that line regardless of who actually originally created |
|---|
| 33 | that line. |
|---|
| 34 | |
|---|
| 35 | The statistics calculated is the number of lines contributed from each |
|---|
| 36 | contributing developer in the latest (checked out) revision. Also, the |
|---|
| 37 | number of lines still in use from each revision is calculated. |
|---|
| 38 | |
|---|
| 39 | There are many different types of files and for many file types it |
|---|
| 40 | does not make sense to define lines. Source code, documentation, and |
|---|
| 41 | other human readable files can be treated on line basis whereas |
|---|
| 42 | symbolic links and binary files cannot. svnstat treats non-line based |
|---|
| 43 | files as one-line files, i.e. the developer that made the last change |
|---|
| 44 | to this type of files gets a one-line credit for it. |
|---|
| 45 | |
|---|
| 46 | How should we exclude un-reasonable credit for large line based files? |
|---|
| 47 | We could add a property to that file, tagging it as a file that should |
|---|
| 48 | be treated as an non-line base file. |
|---|
| 49 | |
|---|
| 50 | The current design assumes that the subversion repository to be |
|---|
| 51 | analysed is checked out, maybe one would want to run the analysis |
|---|
| 52 | agains a subversion repositoy directly. |
|---|
| 53 | |
|---|
| 54 | The current flow of the program is. |
|---|
| 55 | |
|---|
| 56 | i) Extract the directory structure starting from the directory given |
|---|
| 57 | at the command line. |
|---|
| 58 | |
|---|
| 59 | ii) Parse the directory structure, removing files and direcotries that |
|---|
| 60 | is not in subversion control. After this step, only valid |
|---|
| 61 | subversion entries will be allowed in the tree. Beware, 'svn blame' |
|---|
| 62 | chokes on directories, and the directories are still a part of the |
|---|
| 63 | tree. |
|---|
| 64 | |
|---|
| 65 | iii) Walk through the directory structure and calculate statistics for |
|---|
| 66 | each entry. |
|---|
| 67 | |
|---|
| 68 | iv) Compile statistics as discussed. This step may be intermingled |
|---|
| 69 | with step iii). |
|---|
| 70 | |
|---|
| 71 | v) Create the html presentation as discussed. |
|---|
