Author: bodewig
Date: Mon Nov 21 18:05:40 2011
New Revision: 1204623
URL: http://svn.apache.org/viewvc?rev=1204623&view=rev
Log:
document support for concatenating streams
Modified:
ant/antlibs/compress/trunk/changes.xml
ant/antlibs/compress/trunk/docs/compresource.html
ant/antlibs/compress/trunk/docs/unpack.html
Modified: ant/antlibs/compress/trunk/changes.xml
URL:
http://svn.apache.org/viewvc/ant/antlibs/compress/trunk/changes.xml?rev=1204623&r1=1204622&r2=1204623&view=diff
==============================================================================
--- ant/antlibs/compress/trunk/changes.xml (original)
+++ ant/antlibs/compress/trunk/changes.xml Mon Nov 21 18:05:40 2011
@@ -46,6 +46,13 @@
<action type="add">
Support for xz compression has been added.
</action>
+ <action type="add">
+ The gunzip and bunzip2 tasks as well as the corresponding
+ resources now support uncompressing resources that contain
+ multiple concatenated streams as a single stream. This
+ behavior has to be enabled explicitly via the
+ decompressConcatenated attribute.
+ </action>
</release>
<release version="1.1" date="2011-11-05">
Modified: ant/antlibs/compress/trunk/docs/compresource.html
URL:
http://svn.apache.org/viewvc/ant/antlibs/compress/trunk/docs/compresource.html?rev=1204623&r1=1204622&r2=1204623&view=diff
==============================================================================
--- ant/antlibs/compress/trunk/docs/compresource.html (original)
+++ ant/antlibs/compress/trunk/docs/compresource.html Mon Nov 21 18:05:40 2011
@@ -31,11 +31,23 @@
compression or decompression on the fly. A single element resource
collection must be specified as a nested element.</p>
+<a name="decompressConcatenated">
+<p>Resources for the formats that support files holding multiple
+ compressed streams (bzip2, gzip and xz) support a boolean attribute
+ decompressConcatenated. If set to true all streams will be
+ concatenated and treated as a single resource. With the default
+ value false only the first stream is uncompressed.</p>
+</a>
+
<h2><a name="bzip2resource">bzip2resource</a></h2>
<p>This is a <a href="#compresource">compressed resource</a> using the
BZIP2 compression.</p>
+<p>This resource supports
+ the <a href="#decompressConcatenated">decompressConcatenated</a>
+ attribute.</p>
+
<h4>Examples</h4>
<pre>
@@ -56,6 +68,10 @@
<p>This is a <a href="#compresource">compressed resource</a> using the
GZIP compression.</p>
+<p>This resource supports
+ the <a href="#decompressConcatenated">decompressConcatenated</a>
+ attribute.</p>
+
<h4>Examples</h4>
<pre>
@@ -97,6 +113,10 @@
<p>This is a <a href="#compresource">compressed resource</a> using the
XZ compression.</p>
+<p>This resource supports
+ the <a href="#decompressConcatenated">decompressConcatenated</a>
+ attribute.</p>
+
<h4>Examples</h4>
<pre>
Modified: ant/antlibs/compress/trunk/docs/unpack.html
URL:
http://svn.apache.org/viewvc/ant/antlibs/compress/trunk/docs/unpack.html?rev=1204623&r1=1204622&r2=1204623&view=diff
==============================================================================
--- ant/antlibs/compress/trunk/docs/unpack.html (original)
+++ ant/antlibs/compress/trunk/docs/unpack.html Mon Nov 21 18:05:40 2011
@@ -57,6 +57,16 @@ does not exist.</p>
<td valign="top">the destination file or directory.</td>
<td align="center" valign="top">No</td>
</tr>
+ <tr>
+ <td valign="top">
+ <a name="decompressConcatenated">decompressConcatenated</a></td>
+ <td valign="top">Only for the formats that support files holding
+ multiple compressed streams (bzip2, gzip and xz).<br/>
+ If set to true all streams will be concatenated and treated as a
+ single resource. With the default value false only the first
+ stream is uncompressed.</td>
+ <td align="center" valign="top">No</td>
+ </tr>
</table>
<h3>Parameters specified as nested elements</h3>
@@ -70,11 +80,19 @@ resource collection</h4>
<p>Is an <a href="#unpack">uncompressing task</a> that uses the BZIP2
compression algorithm.</p>
+<p>This task supports
+ the <a href="#decompressConcatenated">decompressConcatenated</a>
+ attribute.</p>
+
<h3><a name="gunzip">GUnZip</a></h3>
<p>Is an <a href="#unpack">uncompressing task</a> that uses the GZIP
compression algorithm.</p>
+<p>This task supports
+ the <a href="#decompressConcatenated">decompressConcatenated</a>
+ attribute.</p>
+
<h3><a name="unpack200">Unpack200</a></h3>
<p>Is an <a href="#unpack">uncompressing task</a> that uses
@@ -136,6 +154,10 @@ resource collection</h4>
<p>Is an <a href="#unpack">uncompressing task</a> that uses the XZ
compression algorithm.</p>
+<p>This task supports
+ the <a href="#decompressConcatenated">decompressConcatenated</a>
+ attribute.</p>
+
<h3>Examples</h3>
<blockquote><pre>
<cmp:gunzip src="test.tar.gz"
xmlns:cmp="antlib:org.apache.ant.compress"/>
