aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/manpages/gbp-pq.sgml
blob: c62e7c47f40f8aa47e6981327605fd24c577011d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
<refentry id="gbp.man.gbp.pq">
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
  </refentryinfo>
  <refmeta>
   <refentrytitle>gbp-pq</refentrytitle>
    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&gbp-pq;</refname>

    <refpurpose>Manage quilt patches on patch queue branches in git</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      &gbp-pq;
      <arg><option>export</option>|<option>import</option>|<option>rebase</option>|<option>drop</option></arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>
    <para>
  &gbp-pq helps to manage quilt patches in Debian packages that are maintained
  with &git-buildpackage;. This is especially useful with packages using the
  3.0 (quilt) source format. With &gbp-pq; 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 lifes on <replaceable>master</replaceable>
  the associated patch-queue branch will be called
  <replaceable>patch-queue/master</replaceable>.
    </para>
    <para>
   See <ulink url="https://honk.sigxcpu.org/piki/development/debian_packages_in_git/"></ulink> for example workflows.
    </para>
  </refsect1>
  <refsect1>
    <title>OPTIONS</title>
    <variablelist>
      <varlistentry>
        <term><option>import</option>
        </term>
        <listitem>
	  <para>
	Create a patch queue branch from quilt patches in debian/patches/ that
	are listed in debian/patches/series.
	  </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>export</option>
        </term>
        <listitem>
	  <para>
	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.
	  </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>rebase</option>
        </term>
        <listitem>
	  <para>
	Switch to the patch-queue branch associated to the current branch and
	rebase it against the current branch.
	  </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>drop</option>
        </term>
        <listitem>
	  <para>
	Drop (delete) the patch queue associated to the current branch. So if
	you're on branch <replaceable>foo</replaceable> this would drop branch
	<replaceable>patch-queue/foo</replaceable>.
	  </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
        <refentrytitle>git-buildpackage</refentrytitle>
        <manvolnum>1</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>dpkg-source</refentrytitle>
        <manvolnum>1</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>quilt</refentrytitle>
        <manvolnum>1</manvolnum>
      </citerefentry>,
    </para>
  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>&dhusername; &dhemail;</para>

  </refsect1>
</refentry>