.\" Automatically generated by Pandoc 3.1.3
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "DHT" "1" "" "" ""
.hy
.SH NAME
.PP
dht \[en] Debian Haskell Packaging Tools
.SH SYNOPSIS
.PP
\&./dht subcommand [args..]
.SH DESCRIPTION
.PP
This is the Debian Haskell Team multi purpose tool, combining various
more or less useful tools.
.PP
Supported subcommands:
.IP \[bu] 2
cabal-debian - Run cabal-debian with inferred parameters
.IP \[bu] 2
dch - Append the changelog
.IP \[bu] 2
debian2dsc - generate a dsc file from a debian directory
.IP \[bu] 2
init - Create an initial packaging
.IP \[bu] 2
make-all - Rebuilds a set of packages
.IP \[bu] 2
mass-change - Apply a change to many packages
.IP \[bu] 2
tag - Tag a built package
.IP \[bu] 2
upgrade - Upgrade a package to the version in the package plan
.IP \[bu] 2
upload - Uploads, tags and pushes
.IP \[bu] 2
what-to-build - Find packages to be built
.IP \[bu] 2
what-to-upgrade - Find packages to be upgraded
.IP \[bu] 2
what-to-upload - Lists .changes files that should be uploaded
.SH Subcommands
.SS dht cabal-debian
.PP
Usage: dht cabal-debian [option\&...]
.PP
This is a wrapper around cabal-debian that tries to infer a few useful
facts: * If the test suite is enabled.
* Which Cabal flags are to be used.
* The source package name.
.PP
None of these checks are perfect, so check the result.
.PP
It also passes \f[V]--official\f[R].
.SS dht dch
.PP
Usage: dht dch [debchange option]
.PP
This is a wrapper for debchange(1), which will implement our custom
heuristics of whether a new changelog entry should be created, or the
current one be amended: If the current version is tagged, create a new
changelog entry, else append to the current one.
.PP
It passes either \[en]append or \[en]increment to debchange, so you
should not.
The \[en]newversion option may be used in order to specify the version
number.
.SS dht debian2dsc
.PP
Usage: dht debian2dsc [-o output/] [dir \&...]
.PP
Expects directories containing the contents of the \f[V]debian/\f[R]
directory of a Debian source package (i.e.\ \f[V]control\f[R],
\f[V]changelog\f[R], \f[V]watch\f[R], \&...).
Uses the watch file to retrieve the upstream tarball (unless it already
exists in the local directory), creates a \f[V]debian.tar.xz\f[R]
tarball from the given directory (ignoring the ususal suspects like
\f[V]_darcs\f[R] and \f[V]*\[ti]\f[R]) and creates a corresponding
\f[V].dsc\f[R] file; all without unpacking the upstream tarball.
.SS dht init
.PP
Usage: dht init [-D distribution] Cabal-Pkg \&...
.PP
This script will:
.IP \[bu] 2
Query the package plan for the desired version number of CabalPkg.
.IP \[bu] 2
Use \f[V]cabal unpack --pristine\f[R] to fetch the source into the right
directory
.IP \[bu] 2
Run cabal-debian \[en]official to initialize the packaging.
.IP \[bu] 2
Optimistically mark the package as ready for release
.IP \[bu] 2
Commit this to git.
.PP
Please review the package afterwards, in particular
\f[V]debian/copyright\f[R].
.SS dht make-all
.PP
Usage: dht make-all [\[en]excluded-packages PKG,PKG,\&...]
[-o|\[en]output DIR] [\[en]bindmount DIR] [-j|\[en]jobs INT]
[-c|\[en]chroot SCHROOT] [\[en]shake-verbosity VERBOSITY]
[\[en]keep-going] [\[en]sbuild-option OPTION] [TARGET\&...]
.PP
Rebuilds a set of packages
.PP
Available options: -h,\[en]help Show this help text
\[en]excluded-packages PKG,PKG,\&...
comma or space separated list of source package names to ignore
(default: ghc, ghc-testsuite, haskell-devscripts, haskell98-report,
haskell-platform) -o,\[en]output DIR output directory (default:
\[lq]lab\[rq]) \[en]bindmount DIR directory bind-mounted in the schroot
(default: \[lq]/tmp\[rq]) -j,\[en]jobs INT number of parallel jobs
(default: 1) -c,\[en]chroot SCHROOT name of the schroot to use (default:
\[lq]haskell\[rq]) \[en]shake-verbosity VERBOSITY verbosity for shake
(Silent, Quiet, Normal, Loud, Chatty or Diagnostic) (default: Info)
\[en]keep-going keep going even if there are errors \[en]sbuild-option
OPTION An option to pass on to sbuilder (can be passed multiple times)
.SS dht mass-change
.PP
Usage: dht mass-change [-n] [MESSAGE] [ACTION] DIRECTORY \&...
.PP
This script runs ACTION in each of the given directories.
If the ACTION effected a change, it will add MESSAGE to the changelog.
.PP
It assumes that all directories are in the same git repository as this
script.
It ensures that the repository is clean to begin with, and will commit
all changes at once at the end, if there was a change.
.SS dht tag
.PP
Usage: dht tag [\[en]dry-run] [directory..]
.PP
For all given directories, which should be Debian source packages,
figure out the current version from debian/changeslog and create a tag,
tagging the youngest git commit that changed this particular source
package.
.PP
With \[en]dry-run it simply checks if it could tag everything (suite not
UNRELEASED, not already tagged), and returns 0 if it could.
.SS dht upgrade
.PP
Usage: dht upgrade [-D dist] directory/
.PP
This script will:
.IP \[bu] 2
Query the package plan for the desired version number.
.IP \[bu] 2
Run debchange to amend the debian/changlog.
.IP \[bu] 2
Run cabal-debian \[en]official \[en]upgrade to upgrade the packaging.
.IP \[bu] 2
Optimistically mark the package as ready for release
.IP \[bu] 2
Commit this to git.
.PP
At the end, it will rightfully ask you to review the changes, giving you
a helpful link to the diff between the upstream sources.
.SS dht upload
.PP
Usage: dht upload [-h HOST] [foo.changes]
.PP
Signs the \f[V].changes\f[R] file and the corresponding \f[V].dsc\f[R]
file in a temporary location (to avoid touching the original files),
uploads them to the archive using \f[V]dput\f[R], tags them in the
repository and pushes the tag.
.PP
If the -h parameter is specified, upload to HOST, rather than the dput
\f[V]default_host\f[R].
If mass-uploading, it is suggested to use \f[V]ssh-upload\f[R] for
robustness (see the discussion in #833536).
.PP
If no changes file is given, but the script is run in a debian source
package, it checks the parent directory for an appropriately named
changes file, just like debrelease(1) would do.
.PP
Checks that the distribution is not \f[V]UNRELEASED\f[R] and that the
tag does not exist already.
.SS dht what-to-build
.PP
Usage: dht what-to-build [directory..]
.PP
For all given directories (defaults to \f[V]p/*/\f[R]), check if they
are to be built.
This means, in particular:
.IP \[bu] 2
The latest entry in \f[V]debian/changelog\f[R] is \f[I]not\f[R]
\f[V]UNRELEASED\f[R], and
.IP \[bu] 2
there is no corresponding tag in the git repository.
.SS dht what-to-upgrade
.PP
Usage: dht what-to-upgrade [directory..]
.PP
For all given directories (defaults to \f[V]p/*/\f[R]), check if they
are to be upgraded, i.e.\ that the package plan lists a newer version
than the changelog.
.SS dht what-to-upload
.PP
Usage: dht what-to-upload foo.changes ..
.PP
Given a number of changes files, reports hose that should be uploaded,
i.e.
the distribution is not UNRELEASED and that the tag does not exist
already.
.SH AUTHORS
Debian Haskell Group.