.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH GITPKG 1 "March 18, 2018"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
gitpkg \- export a Debian source package from nominated git revisions
.SH SYNOPSIS
.B gitpkg
.I branch
.RI [ origbranch ]

.SH DESCRIPTION
If \fBgitpkg\fP is run in a \fBgit\fP(1) repo with a single 'branch' specified,
then it will do a \fBgit\-archive\fP export of that branch to the \fBDEB_DIR\fP
directory.  If the package is Debian native it will simply create a source
package from it.  If the package has a Debian version, then an orig tarball will
be expected to already exist for it.  If an orig tarball does not already exist
then what happens next depends on the value of the \fBgitpkg.create\-fake\-orig\fP
configuration option (described below).

If \fBgitpkg\fP is invoked with two branches specified, then the first branch
will be exported as the unpacked complete source, while the second branch will
be exported for the orig.tar.gz.  This allows all local changes to the source
to be recorded in the resulting diff.gz if a pristine upstream branch exists
in the repository.  If an orig tarball already exists for the version at 'branch'
then what happens next depends on the value of the \fBgitpkg.force\-overwrite\-orig\fP
configuration option (described below).

The '\fIbranch\fP' should always have a \fIdebian\fP/ dir and may be any
\fItree-ish\fP object that is accepted by \fBgit\-archive\fP(1).
The '\fIorigbranch\fP', if supplied, should usually not have a \fIdebian\fP/
dir.


.SH CONFIGURATION OPTIONS
Almost all \fBgitpkg\fP configuration is handled using \fBgit\-config\fP(1) now.
The following configuration options are supported:

.TP
.B gitpkg.deb\-dir
May be set to override the default destination directory for exported packages.
Default is '\fI../deb\-packages\fP'.  Available to hook scripts as
.nh
.BR DEB_DIR .
.hy
This may be overridden on the command line with the
.nh
.BI \-\-deb\-dir= path
.hy
option.

.TP
.B gitpkg.build\-rootcmd
May be set to override the default command used to get root for package build
operations.  Default is '\fIfakeroot\fP'.  Available to hook scripts as
.nh
.BR BUILD_ROOTCMD .
.hy

.TP
.B gitpkg.prebuild\-target
May be set to a target or targets from \fIdebian/rules\fP which will be called
after the debian source tree is exported, but before the source package is built.
Some packages may use this to generate autoconf files or the like, which should
generally not be in the repo, but which should be in the distributed package.
The target is invoked using the BUILD_ROOTCMD.  A common use for this hook would
be to call the package's '\fIclean\fP' target.  This hook is unset by default
since gitpkg 0.18.  Previous to that it defaulted to the clean target.
Available to hook scripts as
.nh
.BR PREBUILD_TARGET .
.hy

.TP
.B gitpkg.orig\-compressor
May be set to override the default compression for an exported package.orig.tar.
Default is '\fIgzip\fP'.  For format 3.0 packages, valid values also include
\fIxz\fP and \fIbzip2\fP.  Available to hook scripts as
.nh
.BR ORIG_COMPRESSOR .
.hy

.TP
.B gitpkg.orig\-compress\-level
An optional compression level to use with \fBgitpkg.orig\-compressor\fP.  1 is
usually the fastest and 9 is usually the smallest, with the precise details of
everything between being up to the chosen compressor.  Default is unset (which
will use whatever the compressor default is).  Available to hook scripts as
.nh
.BR ORIG_COMPRESS_LEVEL .
.hy

.PP
.B gitpkg.orig\-gz\-opts
.br
.B gitpkg.orig\-xz\-opts
.br
.B gitpkg.orig\-bz2\-opts
.br
.RS
May be set to pass arbitrary options verbatim to \fIgzip\fP, \fIxz\fP or
\fIbzip2\fP when compressing the orig tarball.  If not specified explicitly,
\fBgitpkg.orig\-gz\-opts\fP will default to include the \fB\-\-no\-name\fP
option so that no timestamp is included in the resulting file, making the
output reproducible.  No default options are used for the other compressors.
To pass multiple options to a compressor you must set this option for it
multiple times (ie. using \fBgit\ config\ \-\-add\fP for each option to use).
.RE

.TP
.B gitpkg.deb\-compressor
May be set to override the default compression used by \fBdpkg\-source\fP(1) for
exported packages.  Default (if unset) is to use whatever \fBdpkg\-source\fP
wants to use.  For format 3.0 packages, valid values also include \fIxz\fP and
\fIbzip2\fP.  Available to hook scripts as
.nh
.BR DEB_COMPRESSOR .
.hy

.TP
.B gitpkg.deb\-compress\-level
An optional compression level to use with \fBgitpkg.deb\-compressor\fP.  1 is
usually the fastest and 9 is usually the smallest, with the precise details of
everything between being up to the chosen compressor.  Default is unset (which
will use whatever the \fBdpkg\-source\fP default is, currently '9').
Available to hook scripts as
.nh
.BR DEB_COMPRESS_LEVEL .
.hy

.TP
.B gitpkg.dpkg\-source
May be set to pass arbitrary options verbatim to \fBdpkg\-source\fP(1) when
building the source package.  Use with caution and at your own risk.  To pass
multiple options to \fBdpkg\-source\fP you must set this option multiple times
(ie. using \fBgit\ config\ \-\-add\fP for each option) due to the otherwise
amusing quoting requirements for options such as
.nh
"\-\-format=3.0\ (native)".
.hy
Default is empty.  Available to hook scripts as the indexed array
.nh
.BR DPKG_SOURCE_OPTS .
.hy
Do not use this to set the \fBdpkg\-source\fP(1) \fB\-Z\fP or \fB\-z\fP options,
they should instead be set using the \fBdeb\-compressor\fP and
\fBdeb\-compress\-level\fP options respectively.
This may be overridden on the command line with the
.nh
.BI \-\-dpkg\-source= arg
.hy
option, which likewise must be passed multiple times to set multiple options.

.TP
.B gitpkg.create\-fake\-orig
Sometimes both upstream source and debian support really are intermingled into
a single branch of the repo but you'd still like to make a 'non-native' package
from it.  \fBgitpkg\fP can fake an orig tarball from such a tree out of everything
but the contents of the debian/ directory.  Setting this option to 'true' makes
that behaviour the default if a single treeish is passed to \fBgitpkg\fP and no
corresponding orig tarball is found.  Setting this option to 'false' will make
\fBgitpkg\fP fail, reporting an error, if a single treeish is passed and no orig
tarball with the correct version already exists for it (and none was retrieved
by a hook script prior to it being needed).  If this option is unset then the
user will be prompted for the correct thing to do if this situation arises.
Default is unset.  Available to hook scripts as
.nh
.BR CREATE_FAKE_ORIG .
.hy

.TP
.B gitpkg.force\-overwrite\-orig
This option controls the behaviour of \fBgitpkg\fP if an 'origbranch' treeish is
specified and the corresponding orig.tar for the 'branch' already exists.
If this is set to 'true', then the orig.tar will be overwritten with the repo
source (to reuse an existing orig.tar simply call \fBgitpkg\fP with only the
single debian 'branch' treeish you wish to export).  If this is set to 'false',
then it is a hard error to attempt to export the upstream source again when the
orig.tar already exists, and \fBgitpkg\fP will terminate and scold you if you try.
If unset you will be prompted about whether to overwrite it or not, and the build
will continue using whichever of the two you selected.  Default is unset.
Available to hook scripts as
.nh
.BR FORCE_OVERWRITE_ORIG .
.hy

.TP
.B gitpkg.keep\-unpacked\-source
This option controls whether or not the unpacked source directory is kept after
the package export and exit hook have successfully completed.  If this is set
to 'true', the unpacked source will be retained.  If set to 'false' or unset
then that directory will be removed as the final operation before \fBgitpkg\fP
exits if all prior operations completed successfully.  Default is unset.
Available to hook scripts as
.nh
.BR KEEP_UNPACKED_SOURCE .
.hy
This may be overridden on the command line with the
.nh
.BI \-\-keep\-unpacked\-source= bool
.hy
option (where 'no' or 'false' will not keep it, and any other value, including
nothing, will).


.SH SCRIPT HOOKS
User defined scripts can be invoked from a number of points during the package
build process.  They are sourced into \fBgitpkg\fP as bash shell snippets, in
most cases in a subshell, so they can read state variables and perform external
actions, but cannot alter the running configuration once a build is in progress.
If a hook returns with a non-zero status, then \fBgitpkg\fP will be terminated.
(Hooks that do terminate gitpkg should take some care not to leave too much of a
mess, but also should leave enough clues intact for the user to diagnose and fix
whatever the problem was.  Useful and informative error messages should be barked
to stderr before exiting in this way.)

Hook scripts may be installed on the host system outside of the repo tree, or
sourced from version controlled files in the repo itself.  Both methods have
advantages and risks for different use cases.  Hook scripts are activated by
the local admin, by setting each relevant \fBgit\-config\fP(1) option with the
path to the script to be executed.  Paths may be absolute or relative to the
directory which that hook is called from.  If a hook is set, the script
\fBmust\fP exist when it is called.  Care should be taken to only enable them
for use by trusted source trees when hooking into files in the repo itself.
Usually you should enable them on a per-repo basis with \fBgit\-config\fP(1)
rather than at a \fB\-\-global\fP or \fB\-\-system\fP level.

.SS A brief admonition against getting hooked:
You should avoid complicated in-package hook arrangements becoming essential for
exporting your package source.  If you need them to create a particular package
correctly, and need strict version binding with the source being released, and
they aren't useful to any other package at all ...  then you're quite probably
doing something, or several things, quite wrong.  Else you're in such deep shit
working around some broken build system that you don't need me to tell you about
it.  Either way, local admin has to enable your hooks before they can run, so if
you want to be friendly to others (and yourself), then keep the 'normal' packaging
work strictly inside the usual package building tools, and leave the gitpkg hooks
free for other local admins to wrap whatever automation it is \fIthey\fP need
around things.  If a particular version of the package source needs some particular
actions performed on it prior to the first source package build, then the
.B PREBUILD_TARGET
option from above is most probably what you want rather than one of these hooks.
Other people can use that again later without needing to have gitpkg around.
The aim is for this to Help You.  For some values of All Of You.  So do be
careful to avoid letting it screw other people over if the hook isn't called,
and/or let them know what they need to do instead if it isn't.  Ok then, there's
the barb to watch out for, so back to the point again:

.SS Hook points
The available hook points are listed below in roughly the order that they
would usually be invoked:

.TP
.B gitpkg.package\-config\-hook
This hook runs in the top level directory of the repo \fBgitpkg\fP was invoked
in, prior to any operations taking place, with all \fBgit\-config\fP(1) sourced
options available to it.  No detailed information about the package itself is
available in the hook environment yet, not even its name or version, only the
tree-ish(es) that \fBgitpkg\fP was passed by the user, but the hook may run its
own self-checks based on the current (possibly 'dirty') contents of the working
tree that \fBgitpkg\fP was invoked in.

This hook is able to modify the \fBgitpkg\fP configuration variables for
subsequent operations.  It can perform operations on the repo if needed, but
since it needs to be committed to the repo before it will ever be called, that
may not be so useful here in practice.  Basically, it can do anything it pleases,
it's just a shell script, nothing else has really begun yet, and it has been
sourced into the topmost shell level of \fBgitpkg\fP.

Its operation is different from the \fBadmin\-config\-hook\fP in only one respect,
the path to this hook \fBmust\fP be relative to the TLD of the repo, and the
revision of the file that will be sourced is checked out from the 'branch'
tree-ish that \fBgitpkg\fP was requested to export.  The file must exist in
that version at the path given.

Available to hook scripts as
.nh
.BR PACKAGE_CONFIG_HOOK .
.hy

.TP
.B gitpkg.admin\-config\-hook
This hook is run after the \fBpackage\-config\-hook\fP returns, and differs from
it in operation only by reading a static file from the current filesystem rather
than extracting a version controlled one from the repo being exported.

This can be used by the local admin to override any package specific options,
that may have been set by the \fBpackage\-config\-hook\fP, with site specific
configuration.  This is a policy control, not a security one.  Security was
all over when you let the \fBpackage\-config\-hook\fP run, this just lets you
override it without having to fake up a new commit changing the package hook.

This is the last hook to run that is able to modify the \fBgitpkg\fP
configuration and set environment options that will be visible to later hooks.
Available to hook scripts as
.nh
.BR ADMIN_CONFIG_HOOK .
.hy
This may be overridden on the command line with the
.nh
.BI \-\-admin\-config\-hook= path
.hy
option.

.TP
.B gitpkg.pre\-export\-hook
This hook runs in the top level directory of the repo, after the package name
and version have been determined, and with the final package configuration
including any tweaking by the previous hooks.  It cannot alter any configuration
options, only act upon them or terminate \fBgitpkg\fP.

This can be used to do things like invoke pristine\-tar or prefetch an existing
orig tarball from some foreign source.  It may perform operations on the repo if
any such are desired, or any other last minute check that needs to be done before
we actually get about the task of exporting the source we want packaged.

Available to hook scripts as
.nh
.BR PRE_EXPORT_HOOK .
.hy

.TP
.B gitpkg.deb\-export\-hook
This hook runs in the top level directory of the exported debian source,
immediately after the source has been exported from the requested \fItree-ish\fP,
and immediately prior to the \fBPREBUILD_TARGET\fP being invoked (if provided).
It cannot alter any configuration options, only act upon them or terminate
\fBgitpkg\fP.  If this hook terminates \fBgitpkg\fP, the exported source directory
will be left on the system for the user to inspect.  Subsequent invocations of
\fBgitpkg\fP for the same release version will overwrite it though.
Available to hook scripts as
.nh
.BR DEB_EXPORT_HOOK .
.hy

.TP
.B gitpkg.orig\-export\-hook
This hook runs in the top level directory of the exported 'upstream' source,
immediately after the source has been exported from the provided \fItree-ish\fP,
and prior to it being compressed into a tarball.  It cannot alter any configuration
options, only act upon them or terminate \fBgitpkg\fP.  If this hook terminates
\fBgitpkg\fP, the exported source directory will be left on the system for the user
to inspect.  Subsequent invocations of \fBgitpkg\fP for the same release version
will overwrite it though.

This hook is \fBonly\fP invoked if the upstream 'origbranch' actually is exported
from the repository.  If an existing orig.tar is found or has been created by some
earlier hook (and it is not being overwritten, see \fBforce\-overwrite\-orig\fP above),
then the operations this hook would perform are presumed to have already happened
for this tarball and it is skipped.

It is not safe to assume that this hook will be executed before or after 
\fBdeb\-export\-hook\fP, and it may in fact be run in parallel with it at some
point in the future.  They both will be entered after \fBpre\-export\-hook\fP
returns, and \fBexit\-hook\fP will not begin until (at least) after both have
returned.  What else happens in the middle of all that we make no firm promises
about at this stage.

Available to hook scripts as
.nh
.BR ORIG_EXPORT_HOOK .
.hy

.TP
.B gitpkg.exit\-hook
This hook runs in the directory where the package \fI.dsc\fP was deposited by
\fBdpkg\-source\fP(1), after all internal \fBgitpkg\fP operations have successfully
completed.  It's too late to alter any configuration options, or even to terminate
\fBgitpkg\fP really.  You can pretty much do what you like from this one, anything
that goes wrong from here on is your own doing.  Available to hook scripts as
.nh
.BR EXIT_HOOK .
.hy
This may be overridden on the command line with the
.nh
.BI \-\-exit\-hook= path
.hy
option.


.SS Hook Environment
The following variables are made available for hook scripts, in addition to those
already listed as shadowing a \fBgit\-config\fP option from above.  Not all of them
are valid/useful at all hook points, see the hook documentation above for the
exceptions applying to specific hooks.

.TP
.B GITPKG_HOOK_API
Permits hook scripts to query what interfaces are available to them.
Has only two numeric components separated by a '.' of which the number
to the right of point will get incremented every time we add some new
variable a hook might access, or add some new knob it might tweak where
existing interfaces have not have changed.  If we do screw up and need
to change some current interface, the number to the left will get bumped.
The current API version is 0.2

.SS Available in API version 0.1
These variables have been available to hooks since gitpkg version 0.13
.TP
.B GITPKG_TREEISH
The user-passed debian 'branch' tree-ish that gitpkg was invoked to export.

.TP
.B GITPKG_ORIG_TREEISH
The 'origbranch' tree-ish that gitpkg was invoked with.  This will be empty
if only a single 'branch' tree-ish was specified.

.TP
.B DEB_SOURCE
The name of the source package to create, without any versioning.
As seen in the Source: field of \fBdpkg\-parsechangelog\fP(1).

.TP
.B DEB_VERSION
The version of the source package to create, without any epoch.
As seen in the name of the .diff.gz and .dsc files.

.TP
.B UPSTREAM_VERSION
The version of the source package to create, without any debian version.
As seen in the name of the orig tarball.  For native packages this will be
the same as \fBDEB_VERSION\fP.

.TP
.B DEB_ORIG
The full versioned filename of the orig tarball to use or create.
This variable is empty for native packages without a Debian version part.

.TP
.B DEB_DSC
The full filename of the package \fI.dsc\fP that will be or has been created.

.TP
.B DEB_PACKAGE
The directory name of the debianised source tree to pass to \fBdpkg\-source\fP(1).

.TP
.B REPO_DIR
An absolute path to the top level directory of the git repo we are exporting from.
Usually, if you need to look out of the tree that you were dropped in, you're
probably doing something (at the) wrong (time), but there are exceptions, and
being able to query \fBgit\-config\fP options is one of them.  That's mostly what
this one is for right now.  See the \fBrepo\-config\-helper\fP documented below.
Be careful if you do use it for much else.


.SS Available in API version 0.2
These variables have been available to hooks since gitpkg version 0.24

.TP
.B GITPKG_AOPTS
An associative array containing the command line options not parsed by \fBgitpkg\fP
itself which can be used to override the behaviour of a hook.  The array is keyed
on the names of the options with the '\-\-' removed.  If an option was passed
multiple times, only the last value passed will be stored in this array.
For example:

.nh
.nf
 $ gitpkg \-\-my\-option=foo \-\-option2 \-\-opt=oops \-\-opt='bar baz'

Will give:

 ${GITPKG_AOPTS[my-option]} = "foo"
 ${GITPKG_AOPTS[option2]}   = ""
 ${GITPKG_AOPTS[opt]}       = "bar baz"
.fi
.hy

.TP
.B GITPKG_IOPTS
An indexed array containing the command line options not parsed by \fBgitpkg\fP
itself which can be used to override the behaviour of a hook. The array contains
the literal option strings passed and so can be used to access options which are
intended to be passed multiple times.
For example:

.nh
.nf
 $ gitpkg \-\-my\-option=foo \-\-option2 \-\-opt=oops \-\-opt='bar baz'

Will give:

 ${GITPKG_IOPTS[0]} = "\-\-my\-option=foo"
 ${GITPKG_IOPTS[1]} = "\-\-option2"
 ${GITPKG_IOPTS[2]} = "\-\-opt=oops"
 ${GITPKG_IOPTS[3]} = "\-\-opt=bar baz"
.fi
.hy

The \fBextract_values_for_option\fP function in \fBrepo\-config\-helper\fP (see
below for details of it) can be used to further parse this array to obtain all
the value(s) for a specific option.


.SS Hook Library
There are some canned hook scripts for various tasks available in
.I /usr/share/gitpkg/hooks
which currently include:

.TP 4
.B cowpoke\-exit\-hook
A simple exit hook which sends the exported package off for building using
.BR cowpoke (1).
To enable it:

.nh
.nf
 $ git config gitpkg.exit\-hook /usr/share/gitpkg/hooks/cowpoke\-exit\-hook
.fi
.hy

Additional \fBgit\-config\fP(1) configuration options:

.RS

.TP 8
.B gitpkg\-cowpoke\-exit\-hook.ask\-first
If 'true' prompt for confirmation before calling \fBcowpoke\fP.
Default is to just go ahead and do it.

.TP 8
.B gitpkg\-cowpoke\-exit\-hook.options
May include any other options to pass verbatim to \fBcowpoke\fP.
To pass multiple options, set this multiple times, once for each option.
This may be overridden on the command line with the
.nh
.BI \-\-cowpoke= arg
.hy
option, which likewise must be passed multiple times to set multiple options.

.RE


.TP 4
.B dpkg\-buildpackage\-exit\-hook
A simple exit hook to build binary packages locally with
.BR dpkg\-buildpackage (1).
To enable it:

.nh
.nf
 $ git config gitpkg.exit\-hook /usr/share/gitpkg/hooks/dpkg\-buildpackage\-exit\-hook
.fi
.hy

Additional \fBgit\-config\fP(1) configuration options:

.RS

.TP 8
.B gitpkg\-dpkg\-buildpackage\-exit\-hook.ask\-first
If 'true' prompt for confirmation before calling \fBdpkg\-buildpackage\fP.
Default is to just do it.

.TP 8
.B gitpkg\-dpkg\-buildpackage\-exit\-hook.options
May include any other options to pass verbatim to \fBdpkg\-buildpackage\fP.
To pass multiple options, set this multiple times, once for each option.
This may be overridden on the command line with the
.nh
.BI \-\-dpkg\-bp= arg
.hy
option, which likewise must be passed multiple times to set multiple options.

.TP 8
.B gitpkg\-dpkg\-buildpackage\-exit\-hook.build\-log
If set 'false' don't save a log of the build process, the default is to
record one.

.RE


.TP 4
.B pristine\-tar\-pre\-export\-hook
A hook to extract an orig tarball using pristine\-tar.  Which orig to extract
is determined by the package version of the 'branch' tree-ish.
To enable it:

.nh
.nf
 $ git config gitpkg.pre\-export\-hook /usr/share/gitpkg/hooks/pristine\-tar\-pre\-export\-hook
.fi
.hy

If a pristine\-tar branch is not found in the repo, then gitpkg will be terminated.


.TP 4
.B quilt\-patches\-deb\-export\-hook
This hook reads a list of revision ranges suitable for \fBgit\-format\-patch\fP(1)
from the file \fIdebian/source/git\-patches\fP, one per line, and exports them to
the \fIdebian/patches\fP directory in a form suitable for (format 3.0) quilt
packages.  It is not required for creating such packages, but permits you to
separate out individual patches however you please from the default single patch
that is otherwise created by \fBdpkg\-source\fP.

To enable it:

.nh
.nf
 $ git config gitpkg.deb\-export\-hook /usr/share/gitpkg/hooks/quilt\-patches\-deb\-export\-hook
.fi
.hy

The contents of \fIdebian/source/git\-patches\fP may include comments (on any
line beginning with a #), empty lines, and expressions of a range of commits.
The revision ranges may include \fB$DEB_VERSION\fP, \fB$UPSTREAM_VERSION\fP,
\fB$DEB_REF\fP or \fB$UPSTREAM_REF\fP.  The first pair will be substituted
with the version of the package being exported, the second pair with those
version strings after mangling by \fBsanitise_git_ref\fP to remap them to a
legal git \fIrefname\fP.  Using the sanitised versions is to be preferred in
most cases.  For example:

.nh
.nf
 # Export all commits between these two treeishes,
 # based on the version of the package being exported.

 upstream/$UPSTREAM_REF..patches/$DEB_REF
.fi
.hy


.TP 4
.B debcherry\-deb\-export\-hook
This hook invokes \fBgit\-debcherry\fP(1) to find and export patches to the
upstream source in a form suitable for use with (format 3.0) quilt packages.
It allows for a more natural (and automatic) workflow than the quilt\-patches
hook above by searching for patches made to the packaging branch that have
not yet been applied upstream.

To enable it:

.nh
.nf
 $ git config gitpkg.deb\-export\-hook /usr/share/gitpkg/hooks/debcherry\-deb\-export\-hook
.fi
.hy

In order to use this hook, a \fB${DEB_ORIG}.commit\fP file must be created which
contains the treeish of the exported upstream source in the repository.  This will
be created automatically (if this hook is enabled) when you export an upstream
tarball by passing both \fIbranch\fP and \fIorigbranch\fP to \fBgitpkg\fP, or if
you use the \fBpristine\-tar\-pre\-export\-hook\fP, which determines an appropriate
commit corresponding to the tarball.  If your upstream tarball is created using
some other mechanism you will need to ensure that file is created yourself.

If using this hook, you may wish to document that in your repository with something
similar to the text in \fI/usr/share/doc/gitpkg/examples/README.debcherry\-export\fP
as a convenience to other users. Your package will still be exportable without this
hook enabled, it just won't have the upstream patches individually separated out
into a quilt series.


.SS Hook Library Helpers
These are even more trivial snippets, for operations which may be shared by
several scripts.  Also found in \fI/usr/share/gitpkg/hooks\fP.  Usually these
would be sourced by other scripts rather than being hooked to directly.

.TP 4
.B repo\-config\-helper
Provides a simple wrapper around `\fBgit config\fP`, which ensures it is called
from the repo tree where any repo-specific config options may be stored.  Useful
to scripts which aren't called from inside the repo tree, but which do have
\fBgit\-config\fP options of their own to query.

Provides the \fBsanitise_git_ref\fP shell function which remaps character
strings that are illegal to use in a git refname.

Provides the \fBextract_values_for_option\fP shell function which can be used
to extract an array of the values for a particular option from \fBGITPKG_IOPTS\fP.

See the content of that file itself for more detailed documentation on the
functions that it provides.


.SH INTERACTIVIY
If you intend to call \fBgitpkg\fP from your own scripts, then you should note
that there are two situations when it may prompt interactively by default.
There is no One True Sane Default for these cases, so it's better to just ask
the user and continue than to make them start the whole process again in the
likely case where they have called \fBgitpkg\fP directly.  For details, see
the \fBgitpkg.force\-overwrite\-orig\fP and \fBgitpkg.create\-fake\-orig\fP config
options above.  You should set both explicitly to the behaviour that you desire
from them if \fBgitpkg\fP should never become interactive.

.SH WORKFLOW
Though \fBgitpkg\fP explicitly does not try to force any particular workflow
procedure upon you in order to make full use of it, it probably is worth making
quick mention of at least one simple way to manage Debian packages in git.

One common repo structure is to keep pristine upstream source on one branch,
which is updated either directly from an upstream repo or by importing tar
archives to it periodically, with the Debian patched source on another branch.
In this situation the task of preparing a new upstream release from a tarball
might look a bit like this:

   Check out the upstream branch
 $ cd myrepo
 $ git checkout upstream

   Remove all old upstream files from the repo
 $ rm \-rf $(all_files_except .git)

   Unpack the new tarball in their place
 $ tar zxf $new_upstream.tar.gz

   Let git figure out what is renamed/new/gone by itself.
   Make sure you don't have things like vim .swp files lurking
   in the tree still at this point.
 $ git add .
 $ git commit \-a
 $ git tag v$upstream_version

   Prepare the Debian branch
 $ git checkout debian
 $ git merge upstream
 $ $(update changelog and other debian patches etc.)
 $ git commit \-a
 $ git tag v${upstream_version}\-$debian_version

   Make a release
 $ gitpkg v${upstream_version}\-$debian_version v$upstream_version
 $ cd ../deb\-packages/mypackage && dpkg\-buildpackage ...

.SH SEE ALSO
.BR git\-debimport (1),
.BR git\-debcherry (1),
.BR git (1),
.BR git\-archive (1),
.BR git\-config (1),
.BR git\-format\-patch (1),
.BR gitattributes (5),
.BR dpkg\-source (1),
.BR cowpoke (1).

.SH AUTHOR
.B gitpkg
was written by Ron <ron@debian.org>.