Add documentation for use_lzip

see https://trac.macports.org/ticket/56035
macports · Jul 1, 2019 · 581af74 · 581af74
1 parent abbb67d
commit 581af74
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 0 deletions.
diff --git a/guide/adoc/portfile-phase.adoc b/guide/adoc/portfile-phase.adoc
@@ -690,6 +690,24 @@ When invoked, it automatically sets:
 use_bzip2           yes
 ----
 
+use_lzip::
+This keyword is for downloads that are compressed
+using the lzma algorithm.
+When invoked, it automatically sets:
+
+  extract.suffix    = .tar.lz
+  extract.cmd       = lzip
+  extract.pre_args  = -dc
+  extract.post_args = "| tar -xf -"
+
+* Default: `no`
+* Example:
+
+[source]
+----
+use_lzip            yes
+----
+
 use_lzma::
 This keyword is for downloads that are compressed using the lzma algorithm.
 When invoked, it automatically sets:

diff --git a/guide/xml/portfile-phase.xml b/guide/xml/portfile-phase.xml
@@ -1177,6 +1177,34 @@ extract.cmd    = bzip
         </listitem>
       </varlistentry>
 
+      <varlistentry>
+        <term>use_lzip</term>
+
+        <listitem>
+          <para>This keyword is for downloads that are compressed using the
+          lzma algorithm. When invoked, it automatically sets:</para>
+
+          <literallayout>extract.suffix    = .tar.lz
+extract.cmd       = lzip
+extract.pre_args  = -dc
+extract.post_args  = | tar -xf -
+
+</literallayout>
+
+          <itemizedlist>
+            <listitem>
+              <para>Default: <option>no</option></para>
+            </listitem>
+
+            <listitem>
+              <para>Example:</para>
+
+              <programlisting>use_lzip             yes</programlisting>
+            </listitem>
+          </itemizedlist>
+        </listitem>
+      </varlistentry>
+
       <varlistentry>
         <term>use_lzma</term>