This is an automated email from the git hooks/post-receive script. ebourg-guest pushed a commit to branch master in repository statsvn.
commit 1967a4a022382b9cd1e7ff53ab6bc4c68bc1e083 Author: Vincent Fourmond <[email protected]> Date: Tue Mar 4 22:55:03 2008 +0000 [statsvn] Added manual page and README.Debian --- debian/changelog | 3 +- debian/copyright | 2 +- debian/manpages/statsvn.1 | 196 ++++++++++++++++++++++++++++++++++++++++++++++ debian/statsvn.manpages | 1 + 4 files changed, 200 insertions(+), 2 deletions(-) diff --git a/debian/changelog b/debian/changelog index 61b46be..86812c3 100644 --- a/debian/changelog +++ b/debian/changelog @@ -6,5 +6,6 @@ statsvn (0.3.1.dfsg-1) UNRELEASED; urgency=low jar containing only statsvn code (and not many more as upstreams'). * 20-disable-jtreemap to disable the jtreemap-based report, as jtreemap is not currently packaged for Debian + * Wrote a manual page, based on the one from statcvs - -- Vincent Fourmond <[email protected]> Tue, 04 Mar 2008 21:10:45 +0100 + -- Vincent Fourmond <[email protected]> Tue, 04 Mar 2008 23:47:36 +0100 diff --git a/debian/copyright b/debian/copyright index bf87d17..f835807 100644 --- a/debian/copyright +++ b/debian/copyright @@ -39,5 +39,5 @@ On Debian systems, the complete text of the GNU Lesser General Public License can be found in `/usr/share/common-licenses/LGPL-2.1'. -The debian packaging is copyright 2008 by Vincent Fourmond, +The debian packaging, is copyright 2008 by Vincent Fourmond, licensed under the same terms as statsvn itself. \ No newline at end of file diff --git a/debian/manpages/statsvn.1 b/debian/manpages/statsvn.1 new file mode 100644 index 0000000..df70e67 --- /dev/null +++ b/debian/manpages/statsvn.1 @@ -0,0 +1,196 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" First parameter, NAME, should be all caps +.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection +.\" other parameters are allowed: see man(7), man(1) +.TH STATSVN 1 "03-04-2008" +.\" Please adjust this date whenever revising the manpage. +.\" +.\" Some roff macros, for reference: +.\" .nh disable hyphenation +.\" .hy enable hyphenation +.\" .ad l left justify +.\" .ad b justify to both left and right margins +.\" .nf disable filling +.\" .fi enable filling +.\" .br insert line break +.\" .sp <n> insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +statsvn \- SVN repository statistic analysis tool +.SH SYNOPSIS +.B svn log --xml -v +.I path/to/repos +.B > +.I svn-logfile.xml + +.B statsvn +.I [options] svn-logfile path/to/repos + +.SH DESCRIPTION +This manual page documents the +.B statsvn +command. +This manual page was written for the Debian distribution +because the original program does not have a manual page. +.PP +.\" TeX users may be more comfortable with the \fB<whatever>\fP and +.\" \fI<whatever>\fP escape sequences to invode bold face and italics, +.\" respectively. +.B 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. + +.br + +The current version of +.B statsvn +generates a static suite of +HTML documents containing tables and chart images. +.B statsvn +is opens source software, released under the terms oft the LGPL. +.B statsvn +is based on +.BR statcvs (1) +(hence the striking similarity between their interfaces and manual +pages) and uses JFreeChart to generate charts. + +.TP +.I svn-log-file +path to the output of +.B svn log --xml -v +for the given repository. +.B IMPORTANT NOTE: +do not forget the +.B -v +option, else +.B statsvn +will crash !!! + +.TP + +.I path/to/repos +path to a checkout of the repository. + +.SH 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 +.BR statsvn 's +website. + +.TP +.B \-version +print the version information and exit + +.TP +.BI \-output\-dir \ dir +directory where HTML suite will be saved + +.TP +.BI \-include \ pattern +include only files matching pattern, e.g. **/*.c;**/*.h + +.TP +.BI \-exclude \ pattern +exclude matching files, e.g. tests/**;docs/** + +.TP +.BI \-title \ title +Project title to be used in reports + +.TP +.BI \-viewcvs \ url +integrate with ViewCVS installation at +.I url + +.TP +.B \-verbose +print extra progress information + +.TP +.BI \-bugzilla \ url +integrate with Bugzilla installation at +.I url + +.TP +.BI \-username \ svnusername +.TP +.BI \-password \ svnpassword +username and password for +.BR svn (1) + +.TP +.B \-xdoc +generates Maven XDoc instead of HTML for output + +.TP +.BI \-threads \ number +How many concurrent +.BR svn (1) +processes will be spawned + +.TP +.B \-dump +dump the Repository content on console. + +.SH IMPORTANT NOTES + +Unlike its cousin +.BR statcvs (1), +.B statsvn +can work on distant repositories. Please note however, that +.B statsvn +needs to download many diffs from the repository, so it is often more +network-efficient to simply +.BR 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 +.I $HOME/.statsvn +directory. + +.B Do not forget the -v option to svn diff ! + +Finally, note that the default value for the number of concurrent +.BR 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 +.I \-threads +parameter. + + +.SH JAVA-WRAPPERS NOTE + +This program is a shell script wrapper based on +.BR java-wrappers (7). +You therefore benefit from several features; please see the +.BR java-wrappers (7) +manual page for more information about them. + + +.SH SEE ALSO + +.BR svn (1), +.BR statcvs (1) +and +.BR java-wrappers (7) + +.BR statsvn 's +website at +.IR http://www.statsvn.org , +and most particularly the user manual at +.IR http://svn.statsvn.org/statsvnwiki/index.php/User_Manual . + + +.SH AUTHOR +This manual page was adapted +by Vincent Fourmond <[email protected]> from the one for +.BR statcvs (1) +written by Christian Bayle <[email protected]>. It was written for the +Debian project, but may be used by others. diff --git a/debian/statsvn.manpages b/debian/statsvn.manpages new file mode 100644 index 0000000..30b0b88 --- /dev/null +++ b/debian/statsvn.manpages @@ -0,0 +1 @@ +debian/manpages/statsvn.1 \ No newline at end of file -- Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-java/statsvn.git _______________________________________________ pkg-java-commits mailing list [email protected] https://alioth-lists.debian.net/cgi-bin/mailman/listinfo/pkg-java-commits
