aboutsummaryrefslogtreecommitdiff
path: root/docs/manpages/gbp-import-dsc.xml
blob: 73c1676475e062ce21b1d552deb49befa63908ae (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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
<refentry id="man.gbp.import.dsc">
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
  </refentryinfo>
  <refmeta>
    <refentrytitle>gbp-import-dsc</refentrytitle>
    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>gbp-import-dsc</refname>
    <refpurpose>Import &debian; packages into a &git; repository</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      &gbp-import-dsc;
      &man.common.options.synopsis;
      <arg><option>--allow-same-versions</option></arg>
      <arg><option>--author-date-is-committer-date</option></arg>
      <arg><option>--author-is-committer</option></arg>
      <arg><option>--debian-branch=</option><replaceable>branch_name</replaceable></arg>
      <arg><option>--debian-tag=</option><replaceable>tag-format</replaceable></arg>
      <arg rep='repeat'><option>--filter=</option><replaceable>pattern</replaceable></arg>
      <arg><option>--keyid=</option><replaceable>gpg-keyid</replaceable></arg>
      <arg><option>--[no-]create-missing-branches</option></arg>
      <arg><option>--[no-]pristine-tar</option></arg>
      <arg><option>--[no-]sign-tags</option></arg>
      <arg><option>--skip-debian-tag</option></arg>
      <arg><option>--upstream-branch=</option><replaceable>branch_name</replaceable></arg>
      <arg><option>--upstream-tag=</option><replaceable>tag-format</replaceable></arg>
      <arg><option>--upstream-vcs-tag=</option><replaceable>tag-format</replaceable></arg>
      <arg><option>--repo-user=</option><option>[GIT|DEBIAN]</option></arg>
      <arg><option>--repo-email=</option><option>[GIT|DEBIAN]</option></arg>
      <arg choice="plain"><replaceable>debian-source.dsc</replaceable></arg>
      <arg choice="opt"><replaceable>target</replaceable></arg>
    </cmdsynopsis>
    <cmdsynopsis>
      &gbp-import-dsc;
      <arg><option>options</option></arg>
      <arg><option>--[no-]allow-unauthenticated</option></arg>
      <group choice="plain">
        <arg><replaceable>URL</replaceable></arg>
      </group>
      <arg choice="opt"><replaceable>target</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>
    <para>
      &gbp-import-dsc; imports a &debian; source package into a &git; repository,
      notes the package version in the commit logs, and commits the change. All
      information, including package name, version, &debian; modifications and upstream
      source, is automatically detected from the source package. After
      import the repository can be used with the other &gbp; tools.
    </para>
    <para>
    If the command is run from within an existing &git; repository, it will import
    into it; if not, a new repository named as the Debian source package is
    created. You can override the location of the new repository by specifying
    the optional <replaceable>target</replaceable> argument.
    </para>
    <para>
      When given a <replaceable>URL</replaceable> &gbp-import-dsc;
      will download the source package prior to importing it. &dget;
      is used for all schemes except for the special
      scheme <replaceable>apt:///</replaceable> which uses &apt-get;
      (and therefore needs <replaceable>deb-src</replaceable>
      entries in your <filename>/etc/apt/sources.list</filename>).
      The later can be abbreviated by using the pseudo URL
      <replaceable>apt:</replaceable>.
    </para>
  </refsect1>
  <refsect1>
    <title>OPTIONS</title>
    <variablelist>
      &man.common.options.description;

      <varlistentry>
        <term><option>--upstream-branch</option>=<replaceable>branch_name</replaceable>
        </term>
        <listitem>
          <para>
          The branch in the &git; repository the upstream sources are put
          onto. Default is <replaceable>upstream</replaceable>.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--debian-branch</option>=<replaceable>branch_name</replaceable>
        </term>
        <listitem>
          <para>
          The branch in the &git; repository the debian sources are put
          onto. 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 keyid for gpg signing tags.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--debian-tag=</option><replaceable>tag-format</replaceable>
        </term>
        <listitem>
          <para>
          Use this tag format when tagging &debian; versions,
          default is <replaceable>debian/%(version)s</replaceable>.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--upstream-tag=</option><replaceable>tag-format</replaceable>
        </term>
        <listitem>
          <para>
          Use this tag format when tagging upstream versions,
          default is <replaceable>upstream/%(version)s</replaceable>.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--upstream-vcs-tag</option>=<replaceable>tag-format</replaceable>
        </term>
        <listitem>
          <para>
          Add <replaceable>tag-format</replaceable> as additional parent to the
          commit of the upstream tarball. Useful when upstream uses git and you
          want to link to its revision history. The
          <replaceable>tag-format</replaceable> can be a pattern similar to
          what <option>--upstream-tag</option> supports.
          </para>
	  <para>
	    The default is to not add upstream tags as additional
	    parents since this requires additional setup to have the upstream
	    sources in the same repository.
	  </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--skip-debian-tag</option>
        </term>
        <listitem>
          <para>
          Don't create &debian; tag after importing the &debian; patch. This can be
          useful if you already created a package but want to further work on
          it after importing it into git.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--filter=</option><replaceable>pattern</replaceable>
        </term>
        <listitem>
          <para>
          Filter out files glob-matching
          <option><replaceable>pattern</replaceable></option> from
          upstream tarballs and the debian tarball of 3.0(quilt)
          packages. Note that the <emphasis>.diff.gz</emphasis> of 1.0
          source format packages is currently not filtered.
	  </para>
	  <para>
	  This option can be given multiple times.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--pristine-tar</option>
        </term>
        <listitem>
          <para>
          Generate pristine-tar delta file.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--allow-unauthenticated</option>
        </term>
        <listitem>
          <para>
            Whether to skip signature verification on
            downloads. Passed on verbatim to &dget; and &apt-get;
            respectively. Use with care.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--allow-same-version</option>
        </term>
        <listitem>
          <para>
          Allow one to import a package with the same debian version.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--author-is-committer</option>
        </term>
        <listitem>
          <para>
          When importing the &debian; patch, use the author identity as
          committer identity.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--author-date-is-committer-date</option>
        </term>
        <listitem>
          <para>
          When importing the &debian; patch, use the author date as
          committer date.
          <warning>
            <para>
            &git; will subtly misbehave if the committer date of a commit is not
            later than or equal to all its parents.
            </para>
          </warning>
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--[no-]create-missing-branches</option>
        </term>
        <listitem>
          <para>
          Create upstream and debian branch if missing.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
	<term><option>--repo-user=</option><option>[GIT|DEBIAN]</option></term>
        <listitem>
          <para>
	    When set to <option>DEBIAN</option>
	    use the <envar>DEBUSER</envar> environment variable to set the
	    user.name &git; configuration otherwise use &git;'s
	    defaults. Only affects newly created repos.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
	<term><option>--repo-email=</option><option>[GIT|DEBIAN]</option></term>
        <listitem>
          <para>
	    When set to <option>DEBIAN</option>
	    use the <envar>DEBEMAIL</envar> environment variable to set the
	    user.email &git; configuration otherwise use &git;'s
	    defaults. Only affects newly created repos.
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    &man.gbp.config-files;
  </refsect1>
  <refsect1>
    <title>EXAMPLES</title>
    <para>
      Download and import a source package from a URL:
    </para>
    <screen>
      &gbp-import-dsc; http://http.debian.net/debian/pool/main/h/hello/hello_2.10-1.dsc
    </screen>
    <para>
      Download and import a source package via <command>apt-get
      source</command> from unstable:
    </para>
    <screen>
      &gbp-import-dsc; apt:hello/sid
    </screen>
    <para>
      Import a source package in the local file system:
    </para>
    <screen>
      &gbp-import-dsc; ../hello_2.10-1.dsc
    </screen>
  </refsect1>
  <refsect1>
    <title>SEE ALSO</title>

    <para>
      <xref linkend="man.gbp.import.dscs"/>,
      <xref linkend="man.gbp.buildpackage"/>,
      <xref linkend="man.gbp.import.orig"/>,
      <xref linkend="man.gbp.dch"/>,
      <citerefentry>
        <refentrytitle>apt-get</refentrytitle>
        <manvolnum>1</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>sources.list</refentrytitle>
        <manvolnum>5</manvolnum>
      </citerefentry>,
      <citerefentry>
        <refentrytitle>dget</refentrytitle>
        <manvolnum>1</manvolnum>
      </citerefentry>,
      <xref linkend="man.gbp.conf"/>,
      &man.seealso.common;
    </para>
  </refsect1>
  <refsect1>
    <title>AUTHOR</title>
    <para>
    &dhusername; &dhemail;
    </para>
  </refsect1>
</refentry>