summaryrefslogtreecommitdiffhomepage
path: root/docs/manpages/gbp-import-srpm.xml
blob: 11f4acbf0f44e46caa88f2c1b0d3f63ce25bd2db (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
<refentry id="man.gbp.import.srpm">
  <refentryinfo>
    <address>
      &rpm-email;
    </address>
    <author>
      &rpm-firstname;
      &rpm-surname;
    </author>
  </refentryinfo>
  <refmeta>
    <refentrytitle>gbp-import-srpm</refentrytitle>
    &rpm-mansection;
  </refmeta>
  <refnamediv>
    <refname>gbp-import-srpm</refname>
    <refpurpose>Import source RPM packages into a Git repository</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      &gbp-import-srpm;
      &man.common.options.synopsis;
      <arg><option>--vendor</option>=<replaceable>VENDOR</replaceable></arg>
      <arg><option>--allow-same-versions</option></arg>
      <arg><option>--author-is-committer</option></arg>
      <arg><option>--packaging-branch=</option><replaceable>BRANCH-NAME</replaceable></arg>
      <arg><option>--packaging-tag=</option><replaceable>TAG-FORMAT</replaceable></arg>
      <arg><option>--skip-packaging-tag</option></arg>
      <arg><option>--packaging-dir=</option><replaceable>DIRECTORY</replaceable></arg>
      <arg><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>--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>--native</option></arg>
      <arg><option>--repo-user=</option><option>[GIT|DEBIAN]</option></arg>
      <arg><option>--repo-email=</option><option>[GIT|DEBIAN]</option></arg>
      <group choice="plain">
        <arg><replaceable>SRPM</replaceable></arg>
        <arg><replaceable>DIRECTORY</replaceable></arg>
      </group>
      <arg choice="opt"><replaceable>target</replaceable></arg>
    </cmdsynopsis>
    <cmdsynopsis>
      &gbp-import-srpm;
      <arg><option>options</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-srpm; imports an RPM source package into a &git; repository,
    notes the package version in the commit logs, and commits the change. All
    information, including package name, version and upstream source is
    automatically detected from the source package but you can override the
    location of the new repository by optionally specifying the
    <replaceable>target</replaceable> argument. The tool supports importing
    both archived (src.rpm files) or unpacked (directory) source RPMs. It also imports
    from http(s)-URLs.
    </para>
  </refsect1>
  <refsect1>
    <title>OPTIONS</title>
    <variablelist>
      &man.common.options.description;

      <varlistentry>
        <term><option>--vendor</option>=<replaceable>VENDOR</replaceable>
        </term>
        <listitem>
          <para>
          Distribution vendor name.
          </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 put
          onto. Default is <replaceable>upstream</replaceable>.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--packaging-branch</option>=<replaceable>BRANCH-NAME</replaceable>
        </term>
        <listitem>
          <para>
          The branch in the &git; repository the packaging files 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>--packaging-tag=</option><replaceable>TAG-FORMAT</replaceable>
        </term>
        <listitem>
          <para>
          Use this tag format when tagging released versions,
          default is <replaceable>%(vendor)s/%(version)s</replaceable>.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--skip-packaging-tag</option>
        </term>
        <listitem>
          <para>
          Do not create packaging tag after importing the packaging files.
          </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-NAME</replaceable>
        </term>
        <listitem>
          <para>
          Add <replaceable>TAG-FORMAT</replaceable> as an additional parent of the
          commit of the upstream tarball. Useful when upstream uses git and you
          want to link to its revision history.
          <replaceable>TAG-FORMAT</replaceable> can be a pattern similar to
          what <option>--upstream-tag</option> supports.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--git-packaging-dir=</option><replaceable>DIRECTORY</replaceable>
        </term>
        <listitem>
          <para>
          Subdirectory where to put the RPM packaging files.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--filter=</option><replaceable>PATTERN</replaceable>
        </term>
        <listitem>
          <para>
          Filter out files glob-matching pattern. 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-same-version</option>
        </term>
        <listitem>
          <para>
          Allow one to re-import a package with an already existing version.
          This will not re-import the upstream sources - only packaging files
          will be re-imported.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--author-is-committer</option>
        </term>
        <listitem>
          <para>
          Use the author identity as the committer when importing upstream
          sources and packaging files.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--[no-]create-missing-branches</option>
        </term>
        <listitem>
          <para>
          Create missing upstream and/or packaging branch if missing.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--orphan-packaging</option>
        </term>
        <listitem>
          <para>
          Import packaging files into an orphan branch that will not be based
          on the upstream branch. Useful if you want to maintain (non-native)
          package using the 'orphan-packaging' model. This option have no
          effect if <option>--native</option> is used.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--native</option>
        </term>
        <listitem>
          <para>
          Treat the package as native package. No separate upstream branch or
          upstream tags will be created.
          </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>SEE ALSO</title>

    <para>
      <xref linkend="man.gbp.buildpackage.rpm"/>,
      <xref linkend="man.gbp.pq.rpm"/>,
      <xref linkend="man.gbp.rpm.ch"/>,
      <xref linkend="man.gbp.conf"/>,
      &man.seealso.common;
    </para>
  </refsect1>
  <refsect1>
    <title>AUTHOR</title>
    <para>
    &rpm-username; &rpm-email;
    </para>
  </refsect1>
</refentry>