Document pristine-lfs support

Signed-off-by: Andrej Shadura <andrew.shadura@collabora.co.uk>

Author: andrewshadura

docs/common.ent

@@ -71,6 +71,7 @@
   <!ENTITY pbuilder    "<productname>Pbuilder</productname>">
   <!ENTITY pk4         "<productname>pk4</productname>">
   <!ENTITY pristine-tar "<productname>pristine-tar</productname>">
+  <!ENTITY pristine-lfs "<productname>pristine-lfs</productname>">
   <!ENTITY svn-buildpackage "<productname>svn-buildpackage</productname>">
 
   <!ENTITY changelog " <filename>debian/changelog</filename>">

docs/manpages/gbp-buildpackage.xml

@@ -60,6 +60,8 @@
       <arg><option>--git-export=</option><replaceable>TREEISH</replaceable></arg>
       <arg><option>--git-[no-]pristine-tar</option></arg>
       <arg><option>--git-[no-]pristine-tar-commit</option></arg>
+      <arg><option>--git-[no-]pristine-lfs</option></arg>
+      <arg><option>--git-[no-]pristine-lfs-commit</option></arg>
       <arg><option>--git-[no-]-purge</option></arg>
       <arg><option>--git-tag-only</option></arg>
       <arg><option>--git-retag</option></arg>
@@ -105,7 +107,7 @@
       </listitem>
       <listitem>
         <para>
-          Build an orig tarball if it doesn't exist. Optionally using &pristine-tar;.
+          Build an orig tarball if it doesn't exist. Optionally using &pristine-lfs; or &pristine-tar;.
         </para>
       </listitem>
       <listitem>
@@ -150,7 +152,8 @@
     <refsect2>
       <title>Upstream tarball creation options</title>
       <para>When &gbp-buildpackage; doesn't find a suitable upstream
-	tarball it will create one either using &pristine-tar;
+        tarball, it will first try to check it out from &pristine-lfs;. If &pristine-lfs;
+        doesn't produce a tarball, &gbp-buildpackage; will create one either using &pristine-tar;
 	or <command>git archive</command>. These options determine how the tarball is created:
       </para>
       <variablelist>
@@ -164,6 +167,26 @@
               the <option>--git-upstream-tag</option>, <option>--git-upstream-tree</option>
               options have no effect when creating tarballs.
             </para>
+            <para>
+              If both <option>--git-pristine-tar</option> and <option>--git-pristine-lfs</option>
+              are specified, <option>--git-pristine-lfs</option> takes precedence.
+            </para>
+          </listitem>
+        </varlistentry>
+	<varlistentry>
+          <term><option>--git-pristine-lfs</option>
+          </term>
+          <listitem>
+            <para>
+              Use pristine-lfs when generating the upstream tarball if
+              it doesn't exist. If this mode is enabled
+              the <option>--git-upstream-tag</option>, <option>--git-upstream-tree</option>
+              options have no effect when creating tarballs.
+            </para>
+            <para>
+              If both <option>--git-pristine-tar</option> and <option>--git-pristine-lfs</option>
+              are specified, <option>--git-pristine-lfs</option> takes precedence.
+            </para>
           </listitem>
 	</varlistentry>
 	<varlistentry>
@@ -256,6 +279,16 @@
               tarball was generated and the pristine-tar data isn't already there.
             </para>
           </listitem>
+        </varlistentry>
+	<varlistentry>
+          <term><option>--git-pristine-lfs-commit</option>
+          </term>
+          <listitem>
+            <para>
+              Commit the tarball to the pristine-lfs branch if a new
+              tarball was generated and is hasn't been already imported there.
+            </para>
+          </listitem>
 	</varlistentry>
 	<varlistentry>
           <term><option>--git-force-create</option>

docs/manpages/gbp-export-orig.xml

@@ -32,6 +32,8 @@
       <arg rep='repeat'><option>--component=</option><replaceable>component</replaceable></arg>
       <arg><option>--[no-]pristine-tar</option></arg>
       <arg><option>--[no-]pristine-tar-commit</option></arg>
+      <arg><option>--[no-]pristine-lfs</option></arg>
+      <arg><option>--[no-]pristine-lfs-commit</option></arg>
       <arg><option>--upstream-signatures=</option>[auto|on|off]</arg>
     </cmdsynopsis>
   </refsynopsisdiv>
@@ -137,7 +139,7 @@
           </para>
           <para>
           This doesn't have any effect if <option>--pristine-tar</option>
-          is being used.
+          or <option>--pristine-lfs</option> is being used.
           </para>
         </listitem>
       </varlistentry>
@@ -203,7 +205,8 @@
         <listitem>
           <para>
           Use pristine-tar when generating the upstream tarball if it doesn't
-          exist.
+            exist. If used with <option>--pristine-lfs</option>, pristine-tar
+            is only used when pristine-lfs didn’t produce a tarball.
           </para>
         </listitem>
       </varlistentry>
@@ -217,6 +220,27 @@
           </para>
         </listitem>
       </varlistentry>
+      <varlistentry>
+        <term><option>--pristine-lfs</option>
+        </term>
+        <listitem>
+          <para>
+          Use pristine-lfs when generating the upstream tarball if it doesn't
+            exist. If used with <option>--pristine-tar</option>, pristine-tar
+            is only used when pristine-lfs didn’t produce a tarball.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term><option>--pristine-lfs-commit</option>
+        </term>
+        <listitem>
+          <para>
+            Commit the tarball to the pristine-lfs branch if a new
+            tarball was generated and is hasn't been already imported there.
+          </para>
+        </listitem>
+      </varlistentry>
     <varlistentry>
         <term><option>--upstream-signatures=</option>[auto|on|off]
         </term>

docs/manpages/gbp-import-dsc.xml

@@ -29,6 +29,7 @@
       <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-]pristine-lfs</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>
@@ -192,6 +193,15 @@
           </para>
         </listitem>
       </varlistentry>
+      <varlistentry>
+        <term><option>--pristine-lfs</option>
+        </term>
+        <listitem>
+          <para>
+          Import tarballs into pristine-lfs.
+          </para>
+        </listitem>
+      </varlistentry>
       <varlistentry>
         <term><option>--allow-unauthenticated</option>
         </term>

docs/manpages/gbp-import-orig.xml

@@ -34,6 +34,7 @@
       <arg rep='repeat'><option>--component=</option><replaceable>component</replaceable></arg>
       <arg><option>--[no-]pristine-tar</option></arg>
       <arg><option>--[no-]filter-pristine-tar</option></arg>
+      <arg><option>--[no-]pristine-lfs</option></arg>
       <arg><option>--[no-]symlink-orig</option></arg>
       <arg><option>--postimport=cmd</option></arg>
       <arg><option>--postunpack=cmd</option></arg>
@@ -289,6 +290,15 @@
           </para>
         </listitem>
       </varlistentry>
+      <varlistentry>
+        <term><option>--[no-]pristine-lfs</option>
+        </term>
+        <listitem>
+          <para>
+          Import tarballs into <command>pristine-lfs</command>.
+          </para>
+        </listitem>
+      </varlistentry>
       <varlistentry>
         <term><option>--[no-]symlink-orig</option></term>
         <listitem>

docs/manpages/man.seealso.xml

@@ -10,5 +10,9 @@
         <refentrytitle>pristine-tar</refentrytitle>
         <manvolnum>1</manvolnum>
       </citerefentry>,
+      <citerefentry>
+        <refentrytitle>pristine-lfs</refentrytitle>
+        <manvolnum>1</manvolnum>
+      </citerefentry>,
       <ulink url="file:///usr/share/doc/git-buildpackage/manual-html/index.html">
       <citetitle>The Git-Buildpackage Manual</citetitle></ulink>