svn commit: r1597457 - in /commons/proper/compress/trunk/src/site/xdoc: limitations.xml zip.xml

[bo...@apache.org]

Author: bodewig
Date: Sun May 25 18:00:32 2014
New Revision: 1597457

URL: http://svn.apache.org/r1597457
Log:
COMPRESS-280 aftermath, ZipArchiveInputStream can't know the size before the data descriptor has been read

Modified:
    commons/proper/compress/trunk/src/site/xdoc/limitations.xml
    commons/proper/compress/trunk/src/site/xdoc/zip.xml

Modified: commons/proper/compress/trunk/src/site/xdoc/limitations.xml
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/site/xdoc/limitations.xml?rev=1597457&r1=1597456&r2=1597457&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/site/xdoc/limitations.xml (original)
+++ commons/proper/compress/trunk/src/site/xdoc/limitations.xml Sun May 25 18:00:32 2014
@@ -140,6 +140,13 @@
      </section>
      <section name="ZIP">
        <ul>
+         <li><code>ZipArchiveInputStream</code> is limited and may
+         even return false contents in some cases, use
+         <code>ZipFile</code> whenever possible.  See <a
+         href="zip.html#ZipArchiveInputStream_vs_ZipFile">the ZIP
+         documentation page</a> for details.  This limitation is a
+         result of streaming data vs using random access and not a
+         limitation of Compress' specific implementation.</li>
          <li>only a subset of compression methods are supported,
          including the most common STORED and DEFLATEd.  IMPLODE and
          SHRINK support is read-only.</li>

Modified: commons/proper/compress/trunk/src/site/xdoc/zip.xml
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/site/xdoc/zip.xml?rev=1597457&r1=1597456&r2=1597457&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/site/xdoc/zip.xml (original)
+++ commons/proper/compress/trunk/src/site/xdoc/zip.xml Sun May 25 18:00:32 2014
@@ -73,6 +73,9 @@
           <li>may return several entries with the same name.</li>
           <li>will not return internal or external attributes.</li>
           <li>may return incomplete extra field data.</li>
+          <li>may return unknown sizes and CRC values for entries
+          until the next entry has been reached if the archive uses
+          the data descriptor feature (see below).</li>
         </ul>
 
         <p><code>ZipArchiveInputStream</code> shares these limitations