aboutsummaryrefslogtreecommitdiff
path: root/docs/manpages/gbp-import-ref.xml
blob: bc9a60b9da7f2827e24f2530c48dd7dc8f864e63 (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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
<refentry id="man.gbp.import.ref">
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
  </refentryinfo>
  <refmeta>
    <refentrytitle>gbp-import-ref</refentrytitle>
    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>gbp-import-ref</refname>
    <refpurpose>Update upstream sources when using &git; only</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      &gbp-import-ref;

      &man.common.options.synopsis;
      <arg><option>--upstream-version=</option><replaceable>version</replaceable></arg>
      <arg><option>--merge-mode=</option><replaceable>[auto|merge|replace]</replaceable></arg>
      <arg><option>--upstream-branch=</option><replaceable>branch_name</replaceable></arg>
      <arg><option>--upstream-tag=</option><replaceable>tag_format</replaceable></arg>
      <arg><option>--upstream-tree=</option><replaceable>[BRANCH|VERSION|commit-id]</replaceable></arg>
      <arg><option>--debian-branch=</option><replaceable>branch_name</replaceable></arg>
      <arg><option>--[no-]sign-tags</option></arg>
      <arg><option>--keyid=</option><replaceable>gpg-keyid</replaceable></arg>
      <arg><option>--postimport=cmd</option></arg>
      <arg><option>--[no-]rollback</option></arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>
    <para>
      &gbp-import-ref; merges upstream git commits onto your &debian-branch;
      You can either specify a branch to merge, give an upstream
      version or specify the commit id directly. If no tag exists for the imported
      commit it will be automatically created.
    </para>
  </refsect1>
  <refsect1>
    <title>OPTIONS</title>
    <variablelist>
      &man.common.options.description;

      <varlistentry>
        <term><option>--upstream-version</option>=<replaceable>version</replaceable></term>
        <term><option>-u</option><replaceable>version</replaceable></term>
        <listitem>
          <para>
            The upstream version to merge. The upstream tag to use will be determined via
	    the <option>--upstream-tag</option>.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--merge-mode=</option><replaceable>[auto|merge|replace]</replaceable></term>
        <listitem>
          <para>
            How to fold the upstream commits onto the
            &debian; packaging branch.
	  </para>
	  <para>
	    <replaceable>merge</replaceable> does a
	    &git; <command>merge</command> leaving you on your own in
	    case of merge conflict resolution.
	  </para>
	  <para>
	    <replaceable>replace</replaceable> mode on the
	    other hand makes the head of the &debian; packaging branch
	    identical to the newly imported tree but preserves the
	    content of the <filename>debian/</filename> directory
	    while keeping the current head as well as the newly
	    imported tree as parents of the generated commit. This is
	    similar to a <option>theirs</option> merge strategy while
	    preserving <filename>debian/</filename>.
          </para>
	  <para>
	    The default is <replaceable>auto</replaceable> which
	    uses <replaceable>replace</replaceable> for 3.0 (quilt) packages
	    and <replaceable>merge</replaceable> otherwise.
	  </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--upstream-branch</option>=<replaceable>branch_name</replaceable>
        </term>
        <listitem>
          <para>
            The branch in the &git; repository the upstream sources are
            on.  Default is <replaceable>upstream</replaceable>.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--upstream-tag=</option><replaceable>tag-format</replaceable>
        </term>
        <listitem>
          <para>
            Use this tag format when looking up upstream tags,
            default is <replaceable>upstream/%(version)s</replaceable>.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--upstream-tree=</option><replaceable>[BRANCH|VERSION|commit-id]</replaceable>
        </term>
        <listitem>
          <para>
	    What to merge into the &debian-branch;.
            <replaceable>BRANCH</replaceable> (the default) merges from the upstream branch.
            <replaceable>VERSION</replaceable> looks for a tag determined from the given
	    upstream version number via the <option>--upstream-version</option> option.
	  </para>
	  <para>
	    Other values are interpreted as git commit id to merge from.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--debian-branch</option>=<replaceable>branch_name</replaceable>
        </term>
        <listitem>
          <para>
            The branch in the &git; repository the &debian; package is being
            developed on, default is <replaceable>master</replaceable>.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--[no-]sign-tags</option>
        </term>
        <listitem>
          <para>
            GPG sign all created tags.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--keyid=</option><replaceable>gpg-keyid</replaceable>
        </term>
        <listitem>
          <para>
            Use this <option><replaceable>keyid</replaceable></option>
            for gpg signing tags.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--import-msg=</option><replaceable>msg-format</replaceable>
        </term>
        <listitem>
          <para>
            Use this format string for the commit message when importing upstream
            versions, default is
            <replaceable>New upstream version %(version)s</replaceable>.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--postimport=<replaceable>cmd</replaceable></option></term>
        <listitem>
          <para>
            Run <replaceable>cmd</replaceable> after the import. The
            hook gets the following environment variables passed:
	    <variablelist>
	      <varlistentry>
		<term><envar>GBP_BRANCH</envar></term>
		<listitem><para>
		  The name of the Debian packaging branch
		</para></listitem>
	      </varlistentry>
	      <varlistentry>
		<term><envar>GBP_TAG</envar></term>
		<listitem><para>
		  The name of the just created upstream tag
		</para></listitem>
	      </varlistentry>
	      <varlistentry>
		<term><envar>GBP_UPSTREAM_VERSION</envar></term>
		<listitem><para>
		  The just imported upstream version
		</para></listitem>
	      </varlistentry>
	      <varlistentry>
		<term><envar>GBP_DEBIAN_VERSION</envar></term>
		<listitem><para>
		  The Debian version of the package with a Debian
		  revision of '-1'
		</para></listitem>
	      </varlistentry>
	    </variablelist>
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--[no-]rollback</option></term>
        <listitem>
          <para>
	    Rollback changes in case of an error.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>EXAMPLES</title>
    <para>
      Merge commits from the &upstream-branch; into the &debian-branch;
      creating a tag for the version <replaceable>0.0~git20180524</replaceable>:
    </para>
    <screen>
    &gbp-import-ref; --upstream-tree=BRANCH -u0.0~git20180524</screen>
    <para>
      Merge commits from the the tag corresponding to version <replaceable>1.0</replaceable>:
    </para>
    <screen>
    &gbp-import-ref; --upstream-tree=VERSION -u1.0</screen>
    <para>
      Merge commits given by a SHA1 creating a tag for the version
      <replaceable>0.0~git20180524</replaceable>
    </para>
    <screen>
    &gbp-import-ref; --upstream-tree=c4398912c -u0.0~git20180524</screen>
  </refsect1>
  <refsect1>
    &man.gbp.config-files;
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>
    <para>
      <xref linkend="man.gbp.buildpackage"/>,
      <xref linkend="man.gbp.import.dsc"/>,
      <xref linkend="man.gbp.import.dscs"/>,
      <xref linkend="man.gbp.dch"/>,
      <xref linkend="man.gbp.conf"/>,
      <citerefentry>
        <refentrytitle>uscan</refentrytitle>
        <manvolnum>1</manvolnum>
	</citerefentry>,
	&man.seealso.common;
    </para>
  </refsect1>
  <refsect1>
    <title>AUTHOR</title>
    <para>
      &dhusername; &dhemail;
    </para>
  </refsect1>
</refentry>
<!--  LocalWords:  xz lzma bzip gzip tarball
-->