statsvn(1)

NAME

statsvn - SVN repository statistic analysis tool

SYNOPSIS

svn log --xml -v path/to/repos > svn-logfile.xml
statsvn [options] svn-logfile path/to/repos

DESCRIPTION

This manual page documents the statsvn command. This manual page was written for the Debian distribution because the original program does not have a manual page.

statsvn is a program that retrieves information from a SVN repository and generates various tables and charts describing the project development, e.g. timeline for the lines of code, contribution of each developer, etc.

The current version of statsvn generates a static suite of HTML documents containing tables and chart images. statsvn is opens source software, released under the terms oft the LGPL. statsvn is based on statcvs(1) (hence the striking similarity between their interfaces and manual pages) and uses JFreeChart to generate charts.

svn-log-file

path to the output of svn log --xml -v for the given repository. IMPORTANT NOTE: do not forget the -v option, else statsvn will crash !!!

path/to/repos

path to a checkout of the repository.

OPTIONS

These programs follow the usual command line syntax, with long options starting with one dash ("-"). A list of common options is included below. For more up-to-date information, see statsvn's website.

-version

print the version information and exit

-output-dir dir

directory where HTML suite will be saved

-include pattern

include only files matching pattern, e.g. **/*.c;**/*.h

-exclude pattern

exclude matching files, e.g. tests/**;docs/**

-title title

Project title to be used in reports

-viewcvs url

integrate with ViewCVS installation at url

-verbose

print extra progress information

-bugzilla url

integrate with Bugzilla installation at url

-username svnusername

-password svnpassword

username and password for svn(1)

-tags 'regularexpression'

includes information about Subversion tags matching regularexpression into the reports (to include all tags use -tags '.*')

-xdoc generates Maven XDoc instead of HTML for output

-threads number

How many concurrent svn(1) processes will be spawned

-dump dump the Repository content on console.

IMPORTANT NOTES

Unlike its cousin statcvs(1), statsvn can work on distant repositories. Please note however, that statsvn needs to download many diffs from the repository, so it is often more network-efficient to simply rsync(1) the repository to a local host and run it on the local copy.

To compensate for that, however, diffs are cached in the $HOME/.statsvn directory.

Do not forget the -v option to svn diff !

Finally, note that the default value for the number of concurrent svn(1) processes might be too much for the target host. If you get weird error messages about unreachable hosts and similar problems, try taking down the -threads parameter.

JAVA-WRAPPERS NOTE

This program is a shell script wrapper based on java-wrappers(7). You therefore benefit from several features; please see the java-wrappers(7) manual page for more information about them.

SEE ALSO

svn(1), statcvs(1) and java-wrappers(7)

statsvn's website at http://www.statsvn.org, and most particularly the user manual at http://svn.statsvn.org/statsvnwiki/index.php/User_Manual.