Skip to content

Commit 309165b

Browse files
andrewshaduraandrewshadura
committed
Document pristine-lfs support
Signed-off-by: Andrej Shadura <[email protected]>
1 parent ce66550 commit 309165b

File tree

6 files changed

+86
-4
lines changed

6 files changed

+86
-4
lines changed

‎docs/common.ent

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@
7171
<!ENTITY pbuilder "<productname>Pbuilder</productname>">
7272
<!ENTITY pk4 "<productname>pk4</productname>">
7373
<!ENTITY pristine-tar "<productname>pristine-tar</productname>">
74+
<!ENTITY pristine-lfs "<productname>pristine-lfs</productname>">
7475
<!ENTITY svn-buildpackage "<productname>svn-buildpackage</productname>">
7576

7677
<!ENTITY changelog " <filename>debian/changelog</filename>">

‎docs/manpages/gbp-buildpackage.xml

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,8 @@
6060
<arg><option>--git-export=</option><replaceable>TREEISH</replaceable></arg>
6161
<arg><option>--git-[no-]pristine-tar</option></arg>
6262
<arg><option>--git-[no-]pristine-tar-commit</option></arg>
63+
<arg><option>--git-[no-]pristine-lfs</option></arg>
64+
<arg><option>--git-[no-]pristine-lfs-commit</option></arg>
6365
<arg><option>--git-[no-]-purge</option></arg>
6466
<arg><option>--git-tag-only</option></arg>
6567
<arg><option>--git-retag</option></arg>
@@ -105,7 +107,7 @@
105107
</listitem>
106108
<listitem>
107109
<para>
108-
Build an orig tarball if it doesn't exist. Optionally using &pristine-tar;.
110+
Build an orig tarball if it doesn't exist. Optionally using &pristine-lfs; or &pristine-tar;.
109111
</para>
110112
</listitem>
111113
<listitem>
@@ -150,7 +152,8 @@
150152
<refsect2>
151153
<title>Upstream tarball creation options</title>
152154
<para>When &gbp-buildpackage; doesn't find a suitable upstream
153-
tarball it will create one either using &pristine-tar;
155+
tarball, it will first try to check it out from &pristine-lfs;. If &pristine-lfs;
156+
doesn't produce a tarball, &gbp-buildpackage; will create one either using &pristine-tar;
154157
or <command>git archive</command>. These options determine how the tarball is created:
155158
</para>
156159
<variablelist>
@@ -164,6 +167,26 @@
164167
the <option>--git-upstream-tag</option>, <option>--git-upstream-tree</option>
165168
options have no effect when creating tarballs.
166169
</para>
170+
<para>
171+
If both <option>--git-pristine-tar</option> and <option>--git-pristine-lfs</option>
172+
are specified, <option>--git-pristine-lfs</option> takes precedence.
173+
</para>
174+
</listitem>
175+
</varlistentry>
176+
<varlistentry>
177+
<term><option>--git-pristine-lfs</option>
178+
</term>
179+
<listitem>
180+
<para>
181+
Use pristine-lfs when generating the upstream tarball if
182+
it doesn't exist. If this mode is enabled
183+
the <option>--git-upstream-tag</option>, <option>--git-upstream-tree</option>
184+
options have no effect when creating tarballs.
185+
</para>
186+
<para>
187+
If both <option>--git-pristine-tar</option> and <option>--git-pristine-lfs</option>
188+
are specified, <option>--git-pristine-lfs</option> takes precedence.
189+
</para>
167190
</listitem>
168191
</varlistentry>
169192
<varlistentry>
@@ -256,6 +279,16 @@
256279
tarball was generated and the pristine-tar data isn't already there.
257280
</para>
258281
</listitem>
282+
</varlistentry>
283+
<varlistentry>
284+
<term><option>--git-pristine-lfs-commit</option>
285+
</term>
286+
<listitem>
287+
<para>
288+
Commit the tarball to the pristine-lfs branch if a new
289+
tarball was generated and is hasn't been already imported there.
290+
</para>
291+
</listitem>
259292
</varlistentry>
260293
<varlistentry>
261294
<term><option>--git-force-create</option>

‎docs/manpages/gbp-export-orig.xml

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@
3232
<arg rep='repeat'><option>--component=</option><replaceable>component</replaceable></arg>
3333
<arg><option>--[no-]pristine-tar</option></arg>
3434
<arg><option>--[no-]pristine-tar-commit</option></arg>
35+
<arg><option>--[no-]pristine-lfs</option></arg>
36+
<arg><option>--[no-]pristine-lfs-commit</option></arg>
3537
<arg><option>--upstream-signatures=</option>[auto|on|off]</arg>
3638
</cmdsynopsis>
3739
</refsynopsisdiv>
@@ -137,7 +139,7 @@
137139
</para>
138140
<para>
139141
This doesn't have any effect if <option>--pristine-tar</option>
140-
is being used.
142+
or <option>--pristine-lfs</option> is being used.
141143
</para>
142144
</listitem>
143145
</varlistentry>
@@ -203,7 +205,8 @@
203205
<listitem>
204206
<para>
205207
Use pristine-tar when generating the upstream tarball if it doesn't
206-
exist.
208+
exist. If used with <option>--pristine-lfs</option>, pristine-tar
209+
is only used when pristine-lfs didn’t produce a tarball.
207210
</para>
208211
</listitem>
209212
</varlistentry>
@@ -217,6 +220,27 @@
217220
</para>
218221
</listitem>
219222
</varlistentry>
223+
<varlistentry>
224+
<term><option>--pristine-lfs</option>
225+
</term>
226+
<listitem>
227+
<para>
228+
Use pristine-lfs when generating the upstream tarball if it doesn't
229+
exist. If used with <option>--pristine-tar</option>, pristine-tar
230+
is only used when pristine-lfs didn’t produce a tarball.
231+
</para>
232+
</listitem>
233+
</varlistentry>
234+
<varlistentry>
235+
<term><option>--pristine-lfs-commit</option>
236+
</term>
237+
<listitem>
238+
<para>
239+
Commit the tarball to the pristine-lfs branch if a new
240+
tarball was generated and is hasn't been already imported there.
241+
</para>
242+
</listitem>
243+
</varlistentry>
220244
<varlistentry>
221245
<term><option>--upstream-signatures=</option>[auto|on|off]
222246
</term>

‎docs/manpages/gbp-import-dsc.xml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
<arg><option>--keyid=</option><replaceable>gpg-keyid</replaceable></arg>
3030
<arg><option>--[no-]create-missing-branches</option></arg>
3131
<arg><option>--[no-]pristine-tar</option></arg>
32+
<arg><option>--[no-]pristine-lfs</option></arg>
3233
<arg><option>--[no-]sign-tags</option></arg>
3334
<arg><option>--skip-debian-tag</option></arg>
3435
<arg><option>--upstream-branch=</option><replaceable>branch_name</replaceable></arg>
@@ -192,6 +193,15 @@
192193
</para>
193194
</listitem>
194195
</varlistentry>
196+
<varlistentry>
197+
<term><option>--pristine-lfs</option>
198+
</term>
199+
<listitem>
200+
<para>
201+
Import tarballs into pristine-lfs.
202+
</para>
203+
</listitem>
204+
</varlistentry>
195205
<varlistentry>
196206
<term><option>--allow-unauthenticated</option>
197207
</term>

‎docs/manpages/gbp-import-orig.xml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
<arg rep='repeat'><option>--component=</option><replaceable>component</replaceable></arg>
3535
<arg><option>--[no-]pristine-tar</option></arg>
3636
<arg><option>--[no-]filter-pristine-tar</option></arg>
37+
<arg><option>--[no-]pristine-lfs</option></arg>
3738
<arg><option>--[no-]symlink-orig</option></arg>
3839
<arg><option>--postimport=cmd</option></arg>
3940
<arg><option>--postunpack=cmd</option></arg>
@@ -289,6 +290,15 @@
289290
</para>
290291
</listitem>
291292
</varlistentry>
293+
<varlistentry>
294+
<term><option>--[no-]pristine-lfs</option>
295+
</term>
296+
<listitem>
297+
<para>
298+
Import tarballs into <command>pristine-lfs</command>.
299+
</para>
300+
</listitem>
301+
</varlistentry>
292302
<varlistentry>
293303
<term><option>--[no-]symlink-orig</option></term>
294304
<listitem>

‎docs/manpages/man.seealso.xml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,9 @@
1010
<refentrytitle>pristine-tar</refentrytitle>
1111
<manvolnum>1</manvolnum>
1212
</citerefentry>,
13+
<citerefentry>
14+
<refentrytitle>pristine-lfs</refentrytitle>
15+
<manvolnum>1</manvolnum>
16+
</citerefentry>,
1317
<ulink url="file:///usr/share/doc/git-buildpackage/manual-html/index.html">
1418
<citetitle>The Git-Buildpackage Manual</citetitle></ulink>

0 commit comments

Comments
 (0)