~ubuntu-branches/ubuntu/breezy/svn-buildpackage/breezy

.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

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

tarball contents (and can overwrite parts of it). To choose this working model,

set the svn property mergeWithUpstream on the Debian directory

("svn propset mergeWithUpstream 1 debian").

.PP

The default behaviour is following:

.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)

.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

Build with dpkg-buildpackage (also see \-\-svn\-builder, \-\-svn\-lintian, etc.)

.P

Create a changelog entry for the future version

.SH OPTIONS

\fB\-\-svn\-verbose\fR

More verbose program output

.TP

\fB\-\-svn\-export\fR

Just export the working directory and do neccessary code merge operations, then exit.

.TP

Don't use file links but try to export or do hard copies of the working

directory (default: use links where possible). This is useful if your package fails

to build because some files, empty directories, broken links, ...  cannot not

be transported with in the default link-copy mode.

\fB\-\-svn\-tag\-only, \-\-svn\-only\-tag\fR

Don't build the package, do only the tag copy

.TP

\fB\-\-svn\-retag\fR

If an existing target directory has been found while trying to create the tag

copy, remove the target directory first.

.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

variables).

.TP

debuild, pdebuild...  WARNING: shell quotation rules do not completely apply

here, better use wrappers for complex constructs. Using this option may break

.TP

\fB\-\-svn\-pass\-diff\fR

Experimental function to generate the .diff.gz contents using svn and pass it

to dpkg-buildpackage. Requires a hacked dpkg-buildpackage script.

.TP

\fB \-\-svn\-prebuild, \-\-svn\-postbuild, \-\-svn\-pretag, \-\-svn\-posttag\fR

Commands (hooks) to be executed before/after the build/tag command invocations.

Examples to fetch the orig tarball from a local pool (trying pool/libX/... to):

.P

.RS

.PD 0

svn-buildpackage --svn-prebuild='a="wget -c http://mymirror/debian/main/pool/";b="/$package/${package}_${upstream_version}.orig.tar.gz"; $a$(echo $package|cut -c0-1)$b || $a$(echo $package | cut -c0-4)$b'

.P

Multiple retries with a bashism:

.P

svn-buildpackage --svn-prebuild='wget -c http://mymirror/debian/main/pool/{`echo $package | cut -c0-1`,`echo $package | cut -c0-4`}/$package/${package}_${upstream_version}.orig.tar.gz'

.P

Or using a bounty, see below...

.P

svn-b --svn-prebuild="wget http://mymirror/debian/main/pool/$guess_loc"

.RE

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.

svn-builder=debuild -EPATH

svn-override=origDir=$HOME/debian/upstream/$PACKAGE

.P

.P

#svn-lintian

.PD

.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

\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

repository layout. In addition, the contents of a custom file

debian/svn\-deblayout will be imported during the initial configuration. Package

maintainers can store this file in the repository to pass correct defaults to

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

be used in hook commands or the package build system.

.TP

\fBPACKAGE\fR, \fBpackage\fR

The source package name

.TP

\fBSVN\_BUILDPACKAGE\fR

Version of svn-buildpackage

.TP

\fBTAG\_VERSION\fR, \fBdebian\_version\fR

The complete Debian version string, also used for the tag copy

.TP

\fBnon\_epoch\_version\fR

Same as debian\_version but without any epoch strings

.TP

\fBupstream\_version\fR

Same as debian\_version but without Debian extensions

.TP

\fBguess\_loc\fR

Guessed upstream source package name in the pool, something like libm/libmeta-html-perl_3.2.1.0.orig.tar.gz

.TP

\fBDIFFSRC\fR

(experimental) shows the location of generated diff file

.P

Following variables are understood by svn-buildpackage:

.TP

\fBFORCETAG\fR

Tells to ignore the signs for an incomplete changelog

.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:

.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"

.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.

.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.

The svn\-buildpackage HOWTO manual (in /usr/share/doc/svn-buildpackage/),

svn\-inject(1), svn\-upgrade(1), svn(1), dpkg\-buildpackage(1), lintian(1).