'\" -*- coding: us-ascii -*-
.if \n(.g .ds T< \\FC
.if \n(.g .ds T> \\F[\n[.fam]]
.de URL
\\$2 \(la\\$1\(ra\\$3
..
.if \n(.g .mso www.tmac
.TH gbp-pq 1 "21 March 2019" "" "git-buildpackage Manual"
.SH NAME
gbp-pq \- Manage quilt patches on patch queue branches in git
.SH SYNOPSIS
'nh
.fi
.ad l
\fBgbp\ pq\fR \kx
.if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
'in \n(.iu+\nxu
[\fB--version\fR] [\fB--help\fR] [\fB--verbose\fR] [\fB--color=\fR[auto|on|off]] [\fB--color-scheme=\fR \fICOLOR_SCHEME\fR] [\fB--[no-]patch-numbers\fR] [\fB--patch-num-format=\fR \fIformat\fR] [\fB--[no-]renumber\fR] [\fB--topic=\fR \fItopic\fR] [\fB--time-machine=\fR \fInum\fR] [\fB--[no-]drop\fR] [\fB--abbrev=\fR \fInum\fR] [\fB--force\fR] [\fB--commit\fR] [\fB--meta-closes=bug-close-tags\fR] [\fB--meta-closes-bugnum=bug-number-format\fR] [\fB--pq-from=\fR \fI[DEBIAN|TAG]\fR] [\fB--upstream-tag=\fR \fItag-format\fR] \fBdrop\fR | \fBexport\fR | \fBimport\fR | \fBrebase\fR | \fBswitch\fR 
'in \n(.iu-\nxu
.ad b
'hy
.SH DESCRIPTION
\fBgbp\ pq\fR helps one to manage quilt patches in Debian packages that are
maintained with \fBgbp\fR. This is especially useful with packages using the
3.0 (quilt) source format. With \fBgbp\ pq\fR, you can maintain the quilt patches
that should be applied to a package on a separate branch called patch-queue
branch. So if your Debian package lives on
\fImaster\fR, the associated patch-queue branch will be
called \fIpatch-queue/master\fR.
.PP
See 
.URL https://honk.sigxcpu.org/piki/development/debian_packages_in_git/ ""
for example workflows.
.SH ACTIONS
.TP 
\*(T<\fBimport\fR\*(T> 
Create a patch queue branch from quilt patches in debian/patches/
that are listed in debian/patches/series. The patches must apply
without fuzz.
.TP 
\*(T<\fBexport\fR\*(T> 
Export the patches on the patch-queue branch associated to the
current branch into a quilt patch series in debian/patches/ and
update the series file.
.TP 
\*(T<\fBrebase\fR\*(T> 
Switch to the patch-queue branch associated to the current branch and
rebase it against the current branch.
.TP 
\*(T<\fBdrop\fR\*(T> 
Drop (delete) the patch queue associated to the current branch. So if
you're on branch \fIfoo\fR, this would drop
branch \fIpatch-queue/foo\fR.
.TP 
\*(T<\fBapply\fR\*(T> 
Add a single patch to the patch-queue similar to using
\fBgit-am\fR. Use \*(T<\fB\-\-topic\fR\*(T> if you want
the patch to appear in a separate subdir when exporting the patch queue
using \*(T<\fBexport\fR\*(T>. This can be used to separate upstream
patches from Debian specific patches.
.TP 
\*(T<\fBswitch\fR\*(T> 
Switch to the patch-queue branch if on the base branch and switch
to base branch if on patch-queue branch.
.SH OPTIONS
.TP 
\*(T<\fB\-\-version\fR\*(T>
Print version of the program, i.e. version of the git-buildpackage
suite
.TP 
\*(T<\fB\-v\fR\*(T>, \*(T<\fB\-\-verbose\fR\*(T>
Verbose execution
.TP 
\*(T<\fB\-h\fR\*(T>, \*(T<\fB\-\-help\fR\*(T>
Print help and exit
.TP 
\*(T<\fB\-\-color=\fR\*(T>[auto|on|off] 
Whether to use colored output.
.TP 
\*(T<\fB\-\-color\-scheme=\fR\*(T>\fICOLOR_SCHEME\fR 
Colors to use in output (when color is enabled). The format for
COLOR_SCHEME is
\&'<debug>:<info>:<warning>:<error>'.
Numerical values and color names are accepted, empty fields imply
the default color. For example,
\*(T<\fB\-\-git\-color\-scheme=\fR\*(T>\*(T<'cyan:34::'\*(T> would
show debug messages in cyan, info messages in blue and other messages
in default (i.e. warning and error messages in red).
.TP 
\*(T<\fB\-\-[no\-]patch\-numbers\fR\*(T> 
Whether or not the patch files should be prefixed with a number.
The default is to export patches with patch numbers. Note,
however, that this normally affects patches whose names are
automatically generated, and has no effect on exporting patches
which have a \*(T<\fBGbp[\-Pq]: Name\fR\*(T> tag, since the
name specified is preserved unless the \*(T<\fB\-\-renumber\fR\*(T>
option is used.
.TP 
\*(T<\fB\-\-patch\-num\-format=\fR\*(T>\fIformat\fR 
The format specifier for patch number prefixes. The default format is '%04d-'.
.TP 
\*(T<\fB\-\-[no\-]renumber\fR\*(T> 
Whether or not to renumber patches exported from the patch queue,
instead of preserving numbers specified in
\*(T<\fBGbp\-Pq: Name\fR\*(T> tags. The default is not to renumber
patches. Useful when patches need to be renamed for the sake of
uniformity. For example, using \*(T<\fB\-\-renumber\fR\*(T> with
\*(T<\fB\-\-no\-patch\-num\fR\*(T> will strip all numeric prefixes from
exported patches.
.TP 
\*(T<\fB\-\-topic=\fR\*(T>\fItopic\fR 
Topic to use when importing a single patch
.TP 
\*(T<\fB\-\-time\-machine=\fR\*(T>\fINUM\fR 
When importing a patch queue fails, go back commit-by-commit on the
current branch to check if the patch-queue applies there. Do this at
most \fINUM\fR times. This can be useful if the
patch-queue doesn't apply to the current branch HEAD anymore, e.g.
after importing a new upstream version.
.TP 
\*(T<\fB\-\-[no\-]drop\fR\*(T>
Whether to automatically drop (delete) the patch queue branch after
a successful export
.TP 
\*(T<\fB\-\-abbrev=\fR\*(T>\fINUM\fR 
When exporting a patch queue abbreviate commit, instead of showing the
full 40-byte hexadecimal object name in header lines, show only a
partial prefix of length \fINUM\fR. This is
useful when existing patches were not generated by \fBgbp\ pq\fR.
.TP 
\*(T<\fB\-\-force\fR\*(T>
In case of \*(T<\fBimport\fR\*(T>, import even if the
patch-queue branch already exists and overwrite its
content with \*(T<\fIdebian/patches\fR\*(T>.
.TP 
\*(T<\fB\-\-export\fR\*(T>
In case of \*(T<\fBexport\fR\*(T>, commit
\*(T<\fIdebian/patches\fR\*(T>the changes to Git after
exporting the patches.
.TP 
\*(T<\fB\-\-meta\-closes=\fR\*(T>\fIbug-close-tags\fR 
What meta tags to look for to generate a commit message when
using \*(T<\fBexport\fR\*(T> \*(T<\fB\-\-commit\fR\*(T>.
The default is \*(T<'Closes|LP'\*(T> to support Debian and Launchpad.
.TP 
\*(T<\fB\-\-meta\-closes\-bugnum=\fR\*(T>\fIbug-number-format\fR 
What regular expression should be used to parse out the
bug number when using
\*(T<\fBexport\fR\*(T> \*(T<\fB\-\-commit\fR\*(T>. The
default is \*(T<'(?:bug|issue)?\e#?\es?\ed+'\*(T>.
See \fBgbp-dch\fR(1) for details.
.TP 
\*(T<\fB\-\-pq\-from=\fR\*(T>\fI[DEBIAN|TAG]\fR 
How to find the starting point for the patch queue base. The options are DEBIAN, that will use the Debian branch as the base for the patch queue branch, and TAG, that will use the corresponding upstream tag as a base for the patch queue branch.

This is only needed if your upstream branch is not merged in the Debian branch.
The default is \fIDEBIAN\fR.
.TP 
\*(T<\fB\-\-upstream\-tag=\fR\*(T>\fITAG-FORMAT\fR 
Use this tag format when looking for tags of upstream versions,
default is \fIupstream/%(version)s\fR.
.SH TAGS
When exporting patches from a patch-queue branch, \fBgbp\ pq\fR will look at the
patch header for special tags it recognizes. All tags need to start at the
first column and require at least one whitespace after the colon.
.TP 
\*(T<\fBGbp[\-Pq]: Ignore\fR\*(T> 
Ignores the commit, no patch is generated out of it.
.TP 
\*(T<\fBGbp[\-Pq]: Name\fR\*(T> \fIname\fR 
The name to use for the patch when running

.nf
\*(T<\fBgbp\ pq\fR export\*(T>
.fi

If unset, it will be formatted like
\fBgit am\fR would format it.
.TP 
\*(T<\fBGbp[\-Pq]: Topic\fR\*(T> \fItopic\fR 
Moves the patch into a subdir called \fItopic\fR
when running 

.nf
\*(T<\fBgbp\ pq\fR export\*(T>
.fi

This allows for some
structure below \*(T<\fIdebian/patches\fR\*(T>.
.TP 
\*(T<\fBGbp\-Pq\-Topic:\fR\*(T> \fItopic\fR 
Deprecated: use \*(T<\fBGbp[\-Pq]: Topic\fR\*(T>
\fItopic\fR instead.
.SH "SEE ALSO"
\fBgbp-buildpackage\fR(1),
\fBdpkg-source\fR(1),
\fBquilt\fR(1),
\fBgbp.conf\fR(5)
.SH AUTHOR
Guido G\(:unther <\*(T<agx@sigxcpu.org\*(T>>