Hi,
Any objections or seconds to the following?
-David
P.S. Debian requires manpages or else I get bug reports like
http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=206646
-------------------------------------------------------------------
Add small manpages for svndumpfilter, svnserve, and svnversion. Much
like the current pages for svn, svnadmin and svnlook these pages
briefly introduce Subversion and then point to the real documentation
for more information.
* build.conf (svndumpfilter,svnserve,svnversion) : Install manpages.
* subversion/svndumpfilter/svndumpfilter.1 : New file.
* subversion/svnserve/svnserve.1 : New file.
* subversion/svnversion/svnversion.1 : New file.
* subversion/svnversion/main.c : Turn the user relevant parts of a
block comment before main() into help text that is displayed if
'svnversion' is run without arguments.
(usage) : New function.
Index: build.conf
===================================================================
--- build.conf (revision 7390)
+++ build.conf (working copy)
@@ -96,6 +96,7 @@
type = exe
path = subversion/svndumpfilter
install = fs-bin
+manpages = subversion/svndumpfilter/svndumpfilter.1
libs = libsvn_repos libsvn_fs libsvn_delta libsvn_subr aprutil apriconv apr
# The subversion repository inspection tool
@@ -213,6 +214,7 @@
type = exe
path = subversion/svnserve
install = fs-bin
+manpages = subversion/svnserve/svnserve.1
libs = libsvn_repos libsvn_fs libsvn_delta libsvn_subr libsvn_ra_svn aprutil apriconv apr
[svnversion]
@@ -221,6 +223,7 @@
path = subversion/svnversion
libs = libsvn_client aprutil apriconv apr neon
install = bin
+manpages = subversion/svnversion/svnversion.1
# ----------------------------------------------------------------------------
#
Index: subversion/svndumpfilter/svndumpfilter.1
===================================================================
--- subversion/svndumpfilter/svndumpfilter.1 (revision 0)
+++ subversion/svndumpfilter/svndumpfilter.1 (revision 0)
@@ -0,0 +1,26 @@
+.\" You can view this file with:
+.\" nroff -man [filename]
+.\"
+.TH svndumpfilter 1
+.SH NAME
+svndumpfilter \- Filter a subversion repository 'dumpfile'.
+.SH SYNOPSIS
+.TP
+\fBsvndumpfilter\fP \fIcommand\fP [\fIoptions\fP & \fIargs\fP]
+.SH OVERVIEW
+Subversion is a version control system, which allows you to keep old
+versions of files and directories (usually source code), keep a log of
+who, when, and why changes occurred, etc., like CVS, RCS or SCCS.
+\fBSubversion\fP keeps a single copy of the master sources. This copy
+is called the source ``repository''; it contains all the information
+to permit extracting previous versions of those files at any time.
+
+For more information about the Subversion project, visit
+http://subversion.tigris.org.
+
+Documentation for Subversion and its tools, including detailed usage
+explanations of the \fBsvn\fP, \fBsvnadmin\fP, and \fBsvnlook\fP
+programs, historical background, philosophical approaches and
+reasonings, etc., can be found at http://svnbook.red-bean.com/.
+
+Run `svndumpfilter help' to access the built-in tool documentation.
Index: subversion/svnserve/svnserve.1
===================================================================
--- subversion/svnserve/svnserve.1 (revision 0)
+++ subversion/svnserve/svnserve.1 (revision 0)
@@ -0,0 +1,26 @@
+.\" You can view this file with:
+.\" nroff -man [filename]
+.\"
+.TH svnserve 1
+.SH NAME
+svnserve \- Server for the 'svn' repository access method
+.SH SYNOPSIS
+.TP
+\fBsvnserve\fP [\fIoptions\fP]
+.SH OVERVIEW
+Subversion is a version control system, which allows you to keep old
+versions of files and directories (usually source code), keep a log of
+who, when, and why changes occurred, etc., like CVS, RCS or SCCS.
+\fBSubversion\fP keeps a single copy of the master sources. This copy
+is called the source ``repository''; it contains all the information
+to permit extracting previous versions of those files at any time.
+
+For more information about the Subversion project, visit
+http://subversion.tigris.org.
+
+Documentation for Subversion and its tools, including detailed usage
+explanations of the \fBsvn\fP, \fBsvnadmin\fP, and \fBsvnlook\fP
+programs, historical background, philosophical approaches and
+reasonings, etc., can be found at http://svnbook.red-bean.com/.
+
+Run `svnserve --help' to access the built-in tool documentation.
Index: subversion/svnversion/main.c
===================================================================
--- subversion/svnversion/main.c (revision 7390)
+++ subversion/svnversion/main.c (working copy)
@@ -70,29 +70,37 @@
sb->wc_url = apr_pstrdup (sb->pool, status->entry->url);
}
+static void
+usage(void)
+{
+ fprintf(stderr,
+ " The svnversion program produces a compact \"version number\"\n"
+ " for the Subversion working copy. The program takes one or\n"
+ " two arguments, the first is the path to the working copy,\n"
+ " the second is the trailing portion of the trunk URL. The\n"
+ " version number is written to standard output. Here is an\n"
+ " example:\n"
+ "\n"
+ " $ svnversion . /repos/svn/trunk \n"
+ " 4168\n"
+ "\n"
+ " The version number will be a single number if the working\n"
+ " copy is single revision, unmodified, not switched and with\n"
+ " an URL that matches the trunk URL argument. If the working\n"
+ " copy is unusual the version number will be more complex:\n"
+ "\n"
+ " 4123:4168 mixed revision working copy\n"
+ " 4168M modified working copy\n"
+ " 4123S switched working copy\n"
+ " 4123:4168MS mixed revision, modified, switched working copy\n"
+ "\n"
+ " If invoked on a directory that is not a working copy, an\n"
+ " exported directory say, the program will output \"exported\".\n"
+ "\n");
+}
-/* The svnversion program uses svn_client_status to produce a compact
- * "version number" for the Subversion working copy. The program takes one
- * or two arguments, the first is the path to the working copy, the second
- * is the trailing portion of the trunk URL. The version number is written
- * to standard output. Here is an example
- *
- * $ svnversion . /repos/svn/trunk
- * 4168
- *
- * The version number will be a single number if the working copy is single
- * revision, unmodified, not switched and with an URL that matches the
- * trunk URL argument. If the working copy is unusual the version number
- * will be more coplex:
- *
- * 4123:4168 a mixed revision working copy
- * 4168M a modified working copy
- * 4123S a switched working copy
- * 4123:4168MS a mixed revision, modified, switched working copy
- *
- * If invoked on a directory that is not a working copy, an exported
- * directory say, the program will output "exported".
- *
+
+/*
* Why is this not an svn subcommand? I have this vague idea that it could
* be run as part of the build process, with the output embedded in the svn
* program. Obviously we don't want to have to run svn when building svn.
@@ -113,7 +121,8 @@
if (argc != 2 && argc != 3)
{
- fprintf(stderr, "usage: svnversion wc_path [trail_url]\n");
+ fprintf(stderr, "usage: svnversion wc_path [trail_url]\n\n");
+ usage();
return EXIT_FAILURE;
}
Index: subversion/svnversion/svnversion.1
===================================================================
--- subversion/svnversion/svnversion.1 (revision 0)
+++ subversion/svnversion/svnversion.1 (revision 0)
@@ -0,0 +1,27 @@
+.\" You can view this file with:
+.\" nroff -man [filename]
+.\"
+.TH svnversion 1
+.SH NAME
+svnversion \- Produce a compact version number for a working copy.
+.SH SYNOPSIS
+.TP
+\fBsvnversion\fP wc_path [\fItrail_url\fP]
+.SH OVERVIEW
+Subversion is a version control system, which allows you to keep old
+versions of files and directories (usually source code), keep a log of
+who, when, and why changes occurred, etc., like CVS, RCS or SCCS.
+\fBSubversion\fP keeps a single copy of the master sources. This copy
+is called the source ``repository''; it contains all the information
+to permit extracting previous versions of those files at any time.
+
+For more information about the Subversion project, visit
+http://subversion.tigris.org.
+
+Documentation for Subversion and its tools, including detailed usage
+explanations of the \fBsvn\fP, \fBsvnversion\fP, and \fBsvnlook\fP
+programs, historical background, philosophical approaches and
+reasonings, etc., can be found at http://svnbook.red-bean.com/.
+
+Run `svnversion' with no arguments to access the built-in tool
+documentation.
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Sun Oct 12 23:05:59 2003