You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by bo...@apache.org on 2014/03/03 07:35:19 UTC
svn commit: r1573457 - in /commons/proper/compress/trunk/src/site: site.xml
xdoc/limitations.xml
Author: bodewig
Date: Mon Mar 3 06:35:19 2014
New Revision: 1573457
URL: http://svn.apache.org/r1573457
Log:
Add a 'known limitations' page
Added:
commons/proper/compress/trunk/src/site/xdoc/limitations.xml (with props)
Modified:
commons/proper/compress/trunk/src/site/site.xml
Modified: commons/proper/compress/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/site/site.xml?rev=1573457&r1=1573456&r2=1573457&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/site/site.xml (original)
+++ commons/proper/compress/trunk/src/site/site.xml Mon Mar 3 06:35:19 2014
@@ -29,6 +29,7 @@
<menu name="Compress">
<item name="Overview" href="/index.html"/>
<item name="Examples" href="/examples.html"/>
+ <item name="Known Limitations" href="/limitations.html"/>
<item name="Conventions" href="/conventions.html"/>
<item name="Issue Tracking" href="/issue-tracking.html"/>
<item name="Download" href="/download_compress.cgi"/>
Added: 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=1573457&view=auto
==============================================================================
--- commons/proper/compress/trunk/src/site/xdoc/limitations.xml (added)
+++ commons/proper/compress/trunk/src/site/xdoc/limitations.xml Mon Mar 3 06:35:19 2014
@@ -0,0 +1,143 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<document>
+ <properties>
+ <title>Known Limitations and Problems</title>
+ </properties>
+
+ <body>
+ <p>This page lists the known limitations and problems of Apache
+ Commons Compress™ grouped by the archiving/compression
+ format they apply to.</p>
+
+ <section name="7z">
+ <ul>
+ <li>only <code>File</code>s are supported as input/output,
+ not streams. In Compress 1.7
+ <code>ArchiveStreamFactory</code> will not auto-detect 7z
+ archives, starting with 1.8 it will throw a
+ <code>StreamingNotSupportedException</code> when reading from
+ a 7z archive.</li>
+ <li>Encryption, solid compression, header compression and
+ LZMA (not LZMA2) are only supported when reading
+ archives</li>
+ <li>Several of the "methods" supported by 7z are not
+ implemented in Compress.</li>
+ <li>No support for multi-volume archives</li>
+ <li>Support for some BCJ filters and the DELTA filter has
+ been added with Compress 1.8. Because of a known bug in
+ version 1.4 of the <a
+ href="http://tukaani.org/xz/java.html">XZ for Java</a>
+ library, archives using BCJ filters will cause an
+ <code>AssertionError</code> when read. If you need support
+ for BCJ filters you must use a version of XZ for Java more
+ recent than 1.4.</li>
+ </ul>
+ </section>
+ <section name="AR">
+ <p>AR archives can not contain directories - this is a
+ limitation of the format rather than one of Compress'
+ implementation.</p>
+ <ul>
+ <li>file names longer than 16 characters are only fully
+ supported using the BSD dialect, the GNU/SRV4 dialect is only
+ supported when reading archives.</li>
+ </ul>
+ </section>
+ <section name="ARJ">
+ <ul>
+ <li>read-only support</li>
+ <li>no support for compression, encryption or multi-volume
+ archives</li>
+ </ul>
+ </section>
+ <section name="BZIP2">
+ <p>We are not aware of any problems.</p>
+ <p>Versions of Compress prior to 1.4.1 are vulnerable to a
+ possible denial of service attack, see the <a
+ href="security.html">Security Reports</a> page for details.</p>
+ </section>
+ <section name="CPIO">
+ <p>We are not aware of any problems.</p>
+ </section>
+ <section name="DUMP">
+ <ul>
+ <li>read-only support</li>
+ <li>only the new-fs format is supported</li>
+ <li>the only compression algorithm supported is zlib</li>
+ </ul>
+ </section>
+ <section name="GZIP">
+ <p>We are not aware of any problems.</p>
+ </section>
+ <section name="JAR">
+ <p>JAR archives are special ZIP archives, all limitations of <a
+ href="#ZIP">ZIP</a> apply to JAR as well.</p>
+ <ul>
+ <li><code>ArchiveStreamFactory</code> cannot tell JAR
+ archives from ZIP archives and will not auto-detect
+ JARs.</li>
+ <li>Compress doesn't provide special access to the archive's
+ MANIFEST</li>
+ </ul>
+ </section>
+ <section name="LZMA">
+ <ul>
+ <li>read-only support</li>
+ </ul>
+ </section>
+ <section name="PACK200">
+ <p>We are not aware of any problems.</p>
+ </section>
+ <section name="SNAPPY">
+ <ul>
+ <li>read-only support</li>
+ </ul>
+ </section>
+ <section name="TAR">
+ <ul>
+ <li>sparse files can neither be read nor written</li>
+ <li>only a subset of the GNU and POSIX extensions are
+ supported</li>
+ <li>In Compress 1.6 <code>TarArchiveInputStream</code> could
+ fail to read the full contents of an entry unless the stream
+ was wrapped in a bufferng stream.</li>
+ </ul>
+ </section>
+ <section name="XZ">
+ <p>We are not aware of any problems.</p>
+ </section>
+ <section name="Z">
+ <ul>
+ <li>read-only support</li>
+ </ul>
+ </section>
+ <section name="ZIP">
+ <ul>
+ <li>only a subset of compression methods are supported,
+ including the most common STORED and DEFLATEd. IMPLODE and
+ SHRINK support is read-only.</li>
+ <li>no support for encryption or multi-volume archives</li>
+ <li>Compress 1.7 has a known bug where the very first entry
+ of an archive will not be read correctly by
+ <code>ZipArchiveInputStream</code> if it used the STORED
+ method.</li>
+ </ul>
+ </section>
+ </body>
+</document>
Propchange: commons/proper/compress/trunk/src/site/xdoc/limitations.xml
------------------------------------------------------------------------------
svn:eol-style = native