[statsvn] 24/37: [statsvn] Update manual page from upstream's wiki
Emmanuel Bourg
ebourg-guest at moszumanska.debian.org
Thu Apr 19 22:55:43 BST 2018
This is an automated email from the git hooks/post-receive script.
ebourg-guest pushed a commit to branch master
in repository statsvn.
commit 162da7dd25bc9b3c5582edd0909728c5ac258da9
Author: Vincent Fourmond <fourmond at debian.org>
Date: Tue Apr 6 20:25:12 2010 +0000
[statsvn] Update manual page from upstream's wiki
---
debian/changelog | 8 ++
debian/manpages/statsvn.1 | 235 ++++++++++++++++++++++++++++++++++++----------
2 files changed, 193 insertions(+), 50 deletions(-)
diff --git a/debian/changelog b/debian/changelog
index 5c69006..38a1057 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,11 @@
+statsvn (0.7.0.dfsg-2) unstable; urgency=low
+
+ * Pull option documentation from upstream's wiki:
+ http://wiki.statsvn.org/Default.aspx?Page=User Manual (closes: 576664)
+ Thanks to Mathieu Malaterre for pointing out.
+
+ -- Vincent Fourmond <fourmond at debian.org> Tue, 06 Apr 2010 22:24:27 +0200
+
statsvn (0.7.0.dfsg-1) unstable; urgency=low
* New upstream release (closes: #572613)
diff --git a/debian/manpages/statsvn.1 b/debian/manpages/statsvn.1
index 7a07626..c22f615 100644
--- a/debian/manpages/statsvn.1
+++ b/debian/manpages/statsvn.1
@@ -83,99 +83,234 @@ For more up-to-date information, see
.BR statsvn 's
website.
+.SS General Options
+
+.TP
+.BI -output-dir \ <directory>
+Specify an output directory. The reports will be generated in this
+directory. The directory will be created if it doesn't exist.
+
+
.TP
-.B \-version
-print the version information and exit
+.BI -include \ <include-pattern-list>
.TP
-.BI \-output\-dir \ dir
-directory where HTML suite will be saved
+.BI -exclude \ <exclude-pattern-list>
+Specify filters to exclude files from the analysis. A file will be
+ignored if it doesn't match any of the patterns in
+.I include-pattern-list\fR, or if it matches any pattern in
+.IR exclude-pattern-list .
+
+The patterns are lists of Apache Ant-style wildcard patterns,
+seperated by colons or semicolons. The wildcards are:
+
+ * '?' matches a single character
+ * '*' matches zero or more characters
+ * '**' matches zero or more directories
+
+For example, src/**/*.java matches all java files in the src directory
+or its subdirectories. Note that *.java only matches java files in the
+root directory, because '*' does not match subdirectories.
+
+One more example:
+
+.I -include "**/*.c:**/*.h" -exclude "legacy/**"
+
+This matches all .c and .h files anywhere in the directory tree except
+those in the legacy directory and its subdirectories.
+
+For more information on Ant's wildcard syntax, see the Patternset
+section of the Ant manual.
+
+If not specified, all files will be included and no files will be
+excluded.
+
+.B Note\fR: Unix users must put the patterns in quotes, or the shell will
+interfere with the wildcards.
+
.TP
-.BI \-include \ pattern
-include only files matching pattern, e.g. **/*.c;**/*.h
+.BI -cache-dir \ <directory>
+Specify a cache directory for information retrieved from the
+Subversion server (e.g. line counts). The data will be saved in this
+directory. The directory will be created if it doesn't exist. By
+default, the current user directory is used.
+
.TP
-.BI \-exclude \ pattern
-exclude matching files, e.g. tests/**;docs/**
+.BI -username \ <subversion_username>
+
+Specify a username to use when connecting to the Subversion server.
.TP
-.BI \-title \ title
-Project title to be used in reports
+.BI -password \ <subversion_username>
+Specify a password to use when connecting to the Subversion server.
.TP
-.BI \-viewvc \ url
-integrate with ViewCVS installation at
-.I url
+.BI -tags \ <tags-regularexpression>
+
+Includes information about Subverison tags into the reports. Only tags
+matching the regular expression are included. To include all tags, add
+-tags '.*' to the command line.
+
+.B Note: \fR Unix users must put the expression in quotes, or the shell will
+interfere with the wildcards.
+
+.B Note: \fR Tags are determined by looking at your repository's /tags
+directory. To be able to use this feature, you must generate the log
+file from the root of your repository, so that the log contains
+information from both the /tags and the /trunk. The checked out
+version does not have to contain the tags directory.
.TP
-.BI \-trac \ url
-integrate with Trac installation at
-.I url
+.BI -tags-dir \ <directory>
+Specifies the root directory from which the tags regular expression is
+evaluated. The default -tags-dir is /tags/
.TP
-.BI \-bugzilla \ url
-integrate with Bugzilla installation at
-.I url
+.BI -no-developer \ <login-name>
+Excludes a Subversion account name from all developer reports. This is
+useful to reduce noise from administrative and other non-developer
+accounts. Multiple accounts can be excluded by adding the option to
+the command line once for each account.
+
+.SS Report Options
.TP
-.BI \-username \ svnusername
+.BI -xdoc
+Generate Maven XDoc instead of HTML. This allows Maven and Maven 2 to
+integrate the reports when it generates the projects Maven
+site. Reports could be placed, for example, into src/site/statsvn.
+
.TP
-.BI \-password \ svnpassword
-username and password for
-.BR svn (1)
+.BI -xml
+Generate XML instead of HTML.
+
.TP
-.BI \-tags \ 'regularexpression'
-includes information about Subversion tags matching
-.I regularexpression
-into the reports (to include all tags use -tags '.*')
+.BI -css \ <stylesheet>
+Optional (default varies for html or xdoc). Specify a Cascading Style
+Sheet for the report. This can be a HTTP URL or a local file. A URL
+will simply be linked in every page of the report. A local file will
+be copied into the report directory.
+
.TP
-.B \-xdoc
-generates Maven XDoc instead of HTML for output
+.BI -notes \ <notes-file>
+The contents of the specified file will be included at the top of the
+report's index page. The file should contain a valid block-level HTML
+fragment, for example:
+
+ <p>
+ These are development statistics for the
+ <a href="http://www.statsvn.org">StatSVN</a>
+ project, created by StatSVN itself.
+ </p>
+ <p>
+ <strong>Note:</strong>
+ This report was generated by an unreleased
+ development version of StatSVN. It might
+ contain features not yet found in the
+ official release.
+ </p>
.TP
-.BI \-threads \ number
-How many concurrent
-.BR svn (1)
-processes will be spawned
+.BI -title \ <title>
+Specifies a display title to be used in the reports. The name of the
+Subversion module will be used as default if no title is specified.
+
+.TP
+.BI -config-file \ <path-to-properties-file>
+Allows one to replace the source control username with more
+information such as real name, website, email and avatar icon. See
+this file for an example.
.TP
-.B \-dump
-dump the Repository content on console.
+.BI -charset \ <charSet>
+Specifies the charset to use in HTML or XDOC output. ISO-8859-1 will
+be used as default if no charset is specified.
+
.TP
-.B \-xdoc
-use
-.I xdoc
-output format.
+.BI -disable-twitter-button
+if present, exclude the Twitter "Tweet This" buttons from the output.
+
+
+.SS Options for Integration with External Tools
.TP
-.B \-xml
-use
-.I xml
-output format.
+.BI -bugzilla
+Specify the URL of a root of a Bugzilla installation. Will
+replace 'Bug ###' in commit logs with a link to the appropriate
+bug. (New in StatSVN)
+
.TP
-.BI \-charset \ name
-Specifies the charset of the output.
+.BI -chora \ <chora-url>
+Specify the URL of a Chora installation for the module. This must be
+the URL of the page for the module's root directory. StatSVN will
+create links to Chora for directories, files and revisions.
+
+
+.TP
+.BI -viewvc \ <viewvc-url>
+Specify the URL of a ViewVC installation for the module. This must be
+the URL of the page for the module's root directory. StatSVN will
+create links to ViewVC for directories, files and revisions.
+
+.TP
+.BI -mantis \ <mantis-url>
+Specify the root URL of a Mantis bug tracker installation. In commit
+messages, this will turn “Bug ####” into a link to the appropriate
+bug.
+
+.TP
+.BI -trac \ <trac-url>
+Specify the root URL of a Trac installation. In commit messages, this
+will turn “Bug ####” into a link to the appropriate bug.
+
+.SS Miscellaneous Options
.TP
-.B \-verbose
-print extra progress information
+.BI -debug
+Output lots of additional progress information.
+.TP
+.BI -verbose
+Output additional progress information.
+
+.TP
+.BI -version
+Output the version of StatSVN.
+
+.TP
+.BI -dump
+Will output the repository content on console and stop
+
+
+.TP
+.BI -concurrency-threshold \ <millisec>
+Switch to concurrent svn diff if the first call takes more than the
+threshold (in milliseconds) (default: 4000)
+
+.TP
+.BI -threads \ <int>
+How many threads for svn diff (default: 25)
+
+.TP
+.BI -anonymize
+Anonymizes committer names.
.SH IMPORTANT NOTES
Unlike its cousin
.BR statcvs (1),
.B statsvn
-can work on distant repositories. Please note however, that
+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
+network-efficient to simply
.BR rsync (1)
the repository to a local host and run it on the local copy.
@@ -189,7 +324,7 @@ 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
+taking down the
.I \-threads
parameter.
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-java/statsvn.git
More information about the pkg-java-commits
mailing list