svn commit: r1491177 - in /commons/proper/compress/trunk/src/site/xdoc: examples.xml index.xml

[bo...@apache.org]

Author: bodewig
Date: Sun Jun  9 10:24:20 2013
New Revision: 1491177

URL: http://svn.apache.org/r1491177
Log:
not the current limitations of 7z and arj support

Modified:
    commons/proper/compress/trunk/src/site/xdoc/examples.xml
    commons/proper/compress/trunk/src/site/xdoc/index.xml

Modified: commons/proper/compress/trunk/src/site/xdoc/examples.xml
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/site/xdoc/examples.xml?rev=1491177&r1=1491176&r2=1491177&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/site/xdoc/examples.xml (original)
+++ commons/proper/compress/trunk/src/site/xdoc/examples.xml Sun Jun  9 10:24:20 2013
@@ -32,9 +32,10 @@
         compressed) archive are archiver formats.</p>
 
         <p>The compressor formats supported are gzip, bzip2, xz and
-        Pack200, the archiver formats are ar, cpio, dump (read-only),
-        tar, zip, 7z and arj.  Pack200 is a special case as it can only
-        compress JAR files.</p>
+        Pack200, the archiver formats are ar, cpio, tar and zip as
+        well as dump, 7z and arj for which we currently only support
+        reading.  Pack200 is a special case as it can only compress
+        JAR files.</p>
       </subsection>
 
       <subsection name="Common Notes">
@@ -426,6 +427,11 @@ xzIn.close();
 
       <subsection name="7z">
 
+        <p>Note that Commons Compress currently only supports
+        uncompressed entries or entries compressed using BZIP2 or
+        LZMA2 and no header compression at all.  Only AES-256/SHA-256
+        are supported for encryption.</p>
+
         <p>Uncompressing a given 7z archive (you would
           certainly add exception handling and make sure all streams
           get closed properly):</p>
@@ -441,6 +447,9 @@ LOOP UNTIL entry.getSize() HAS BEEN READ
 
       <subsection name="arj">
 
+        <p>Note that Commons Compress doesn't support compressed,
+        encrypted or multi-volume ARJ archives, yet.</p>
+
         <p>Uncompressing a given arj archive (you would
           certainly add exception handling and make sure all streams
           get closed properly):</p>

Modified: commons/proper/compress/trunk/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/site/xdoc/index.xml?rev=1491177&r1=1491176&r2=1491177&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/site/xdoc/index.xml (original)
+++ commons/proper/compress/trunk/src/site/xdoc/index.xml Sun Jun  9 10:24:20 2013
@@ -76,7 +76,8 @@
             archivers where the <a href="zip.html">zip</a>
             implementation provides capabilities that go beyond the
             features found in java.util.zip.  As of Commons Compress
-            1.3 support for the dump, 7z and arj formats is read-only.</p>
+            1.6 support for the dump, 7z and arj formats is
+            read-only.</p>
 
           <p>The compress component provides abstract base classes for
             compressors and archivers together with factories that can