Package: svn-buildpackage Version: 0.6.14 Severity: wishlist Tags: patch
I have read over the svn-buildpackage(1) manpage and made some changes that hopefully make it more readable. I started off with just spelling corrections but ended up rewording some small sections of it.
--- svn-buildpackage-0.6.14.orig/doc/svn-buildpackage.1 2006-06-21 21:15:26.000000000 +1000 +++ svn-buildpackage-0.6.14/doc/svn-buildpackage.1 2006-06-21 21:43:29.000000000 +1000 @@ -5,12 +5,12 @@ .B svn\-buildpackage [ \fIOPTIONS\fR... ] [ \fIOPTIONS for dpkg\-buildpackage \fR] .SH DESCRIPTION -Builds Debian package within the SVN repository. The source code +Builds a Debian package from a Subversion repository. The source code repository must be in the format created by svn\-inject, and this script -must be executed from the work directory (trunk/package). +must be executed from the working directory (trunk/package). .PP By default, the working directory is used as the main source directory -(assuming the whole upstream source is beeing stored in the repository). The +(assuming the whole upstream source is being stored in the repository). The alternative is so called "merge mode". With this method, only the debian directory (and maybe some other modified files) are stored in the repository. At build time, the contents of the svn trunk are copied to the extracted @@ -22,7 +22,7 @@ .P Check the working directory, complain on uncommited files (also see \-\-svn\-ignore\-new) .P -Copy the orig tarball to the build area if neccessary (also see \-\-svn\-no\-links) +Copy the orig tarball to the build area if necessary (also see \-\-svn\-no\-links) .P Extract the tarball (in merge mode) or export the svn work directory to the build directory (also see below and \-\-svn\-no\-links) .P @@ -41,8 +41,8 @@ Don't run debian/rules clean (default: clean first) .TP \fB\-\-svn\-dont\-purge\fR -Don't run remove the build directory when the build is done. (Default: -wipe after successfull build) +Don't remove the build directory when the build is done. (Default: +remove after successful build) .TP \fB\-\-svn\-export\fR Just export the working directory and do neccessary code merge operations, then exit. @@ -71,22 +71,22 @@ \fB\-\-svn\-reuse\fR If possible, reuse an existing build directory in subsequent builds. The build directory is not purged after the build, it is not renamed when a build starts -and the files are just copied over into it. Usefull in mergeWithUpstream mode -with large package. +and the files are just copied over into it. Useful in mergeWithUpstream mode +with large packages. .TP \fB\-\-svn\-lintian\fR, \fB\-\-svn\-linda\fR Run lintian or linda on the resulting changes file when done. .TP \fB\-\-svn\-move\fR When done, move the created files (as listed in .changes) to the parent -directory, relativ to the one where svn-buildpackage was started. +directory, relative to the one where svn-buildpackage was started. .TP \fB\-\-svn\-move-to\fR=... Specifies the target directory to move generated files to. .TP \fB\-\-svn\-pkg\fR=packagename -Overrides the detected package name, use with caution. May be set too late -during the processing (ie. still have the old value when expanding shell +Overrides the detected package name. Use with caution \- it could be set too +late during the processing (eg. still have the old value when expanding shell variables). .TP \fB\-\-svn\-override\fR=var=value,anothervar=value @@ -127,8 +127,8 @@ svn\-buildpackage's behaviour can be modified using the file \fB~/.svn\-buildpackage.conf\fR. Additional parts can be added in each package working directory using the file \fB~/.svn/svn\-buildpackage.conf\fR. -It is basicaly a list of the long command line options (without leading -minus signs), one argument per line (but without quotes embrassing +It is a list of the long command line options (without leading +minus signs), one argument per line (but without quotes surrounding multi-word arguments). The variables are expanded with the system shell if potential shell variables were found there. Avoid ~ sign because of unreliable expansion, better use $HOME instead. @@ -148,7 +148,7 @@ .RE .SH DIRECTORY LAYOUT HANDLING By default, svn-buildpackage expects a configuration file with path/url -declaration, .svn/deb\-layout. The values there can be overriden with the +declaration, .svn/deb\-layout. The values there can be overridden with the \fB\-\-svn\-override\fR option, see above. If a config file could not be found, the settings are autodetected following the usual assumptions about local directories and @@ -158,7 +158,7 @@ new svn-buildpackage users. The format is the same as in the file .svn/deb\-layout. .SH ENVIRONMENT VARIABLES -Following environment variables are exported by \fBsvn-buildpackage\fR and can +The following environment variables are exported by \fBsvn-buildpackage\fR and can be used in hook commands or the package build system. .TP \fBPACKAGE\fR, \fBpackage\fR @@ -182,35 +182,41 @@ \fBDIFFSRC\fR (experimental) shows the location of generated diff file .P -Following variables are understood by svn-buildpackage: +The following variables are understood by svn-buildpackage: .TP \fBFORCETAG\fR -Tells to ignore the signs for an incomplete changelog +Ignore the signs of an incomplete changelog and tag the repository anyway .TP \fBFORCEEXPORT\fR Export upstream source from the repository even if mergeWithUpstream property is set .SH RECOMMENDATIONS -First thing, using shell aliases makes sense. Example for the Bash: +Use shell aliases. An example for bash: .RS .PD 0 -alias svn-b="svn-buildpackage -us -uc -rfakeroot --svn-ignore" -alias svn-br="svn-b --svn-dont-purge --svn-reuse" -alias svn-bt="svn-buildpackage --svn-tag -rfakeroot" +alias svn-b="svn-buildpackage -us -uc -rfakeroot --svn-ignore"; +alias svn-br="svn-b --svn-dont-purge --svn-reuse"; +alias svn-bt="svn-buildpackage --svn-tag -rfakeroot"; +.PD +.RE +They have the following meanings: +.RS +.PD 0 +build regardless of new or changed files; +build regardless of new or changed files and reuse the build directory; +build and tag. .PD .RE -That simply has the meaning: "just build no matter what", the same without -re-exporting on repeated builds and "build for upload and tag". .P -To access remote repositories, the shell access (via ssh) is the easiest way to -create the link. However, it requires to enter the password and this happens -more often with svn\-buildpackage. There are workarounds: use ssh key -without passphrase (insecure and still slow connection) or use the fsh tool -which keeps a persistent connection in background and behaves like a rsh/ssh -command. For details, see svn\-buildpackage manual. +SSH is the easiest way to access remote repositories, although it usually +requires entering a password more frequently with svn\-buildpackage. +Workarounds include using an ssh key without a passphrase (although this is +insecure and still relatively slow), or the fsh tool +which keeps a persistent connection in background and behaves like an rsh/ssh +command. For details, see the svn\-buildpackage manual. .P Another way to get a remote link is using the Subversion DAV module (with SSL -and Apache user authentication), see svn\-buildpackage HOWTO manual for details. +and Apache user authentication), see the svn\-buildpackage HOWTO manual for details. .SH "SEE ALSO" The svn\-buildpackage HOWTO manual (in /usr/share/doc/svn-buildpackage/), svn\-inject(1), svn\-upgrade(1), svn(1), dpkg\-buildpackage(1), lintian(1).
