commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bode...@apache.org
Subject svn commit: r1160114 - in /commons/proper/compress/trunk/src: changes/changes.xml site/xdoc/examples.xml site/xdoc/index.xml
Date Mon, 22 Aug 2011 05:47:26 GMT
Author: bodewig
Date: Mon Aug 22 05:47:26 2011
New Revision: 1160114

URL: http://svn.apache.org/viewvc?rev=1160114&view=rev
Log:
Add documentation for dump support.  COMPRESS-132

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

Modified: commons/proper/compress/trunk/src/changes/changes.xml
URL: http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/changes/changes.xml?rev=1160114&r1=1160113&r2=1160114&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/changes/changes.xml (original)
+++ commons/proper/compress/trunk/src/changes/changes.xml Mon Aug 22 05:47:26 2011
@@ -46,6 +46,10 @@ The <action> type attribute can be add,u
   <body>
     <release version="1.3" date="unreleased"
              description="Release 1.3 - API compatible to 1.2 but requires Java5 at runtime">
+      <action issue="COMPRESS-132" type="add" date="2011-08-17">
+        Read-only support for the format used by the Unix dump(8) tool
+        has been added.
+      </action> 
       <action issue="COMPRESS-36" type="update" date="2011-08-15">
         The ZIP package now supports Zip64 extensions.
       </action> 

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=1160114&r1=1160113&r2=1160114&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/site/xdoc/examples.xml (original)
+++ commons/proper/compress/trunk/src/site/xdoc/examples.xml Mon Aug 22 05:47:26 2011
@@ -137,6 +137,30 @@ LOOP UNTIL entry.getSize() HAS BEEN READ
 
       </subsection>
 
+      <subsection name="dump">
+
+        <p>In addition to the information stored
+          in <code>ArchiveEntry</code> a <code>DumpArchiveEntry</code>
+          stores various attributes including information about the
+          original owner and permissions.</p>
+
+        <p>As of Commons Compress 1.3 only dump archives using the
+          new-fs format - this is the most common variant - are
+          supported.  Right now this library supports uncompressed and
+          ZLIB compressed archives and can not write archives at
+          all.</p>
+
+        <p>Reading entries from an dump archive:</p>
+<source><![CDATA[
+DumpArchiveEntry entry = dumpInput.getNextDumpEntry();
+byte[] content = new byte[entry.getSize()];
+LOOP UNTIL entry.getSize() HAS BEEN READ {
+    dumpInput.read(content, offset, content.length - offset);
+}
+]]></source>
+
+      </subsection>
+
       <subsection name="tar">
 
         <p>In addition to the information stored

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=1160114&r1=1160113&r2=1160114&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/site/xdoc/index.xml (original)
+++ commons/proper/compress/trunk/src/site/xdoc/index.xml Mon Aug 22 05:47:26 2011
@@ -26,7 +26,7 @@
         <section name="Apache Commons Compress&#x2122;">
             <p>
                 The Apache Commons Compress library defines an API for
-                working with ar, cpio, tar, zip, gzip and bzip2 files.
+                working with ar, cpio, Unix dump, tar, zip, gzip and bzip2 files.
             </p>
             <p>
                 The code in this component has many origins:
@@ -67,10 +67,11 @@
             the <code>java.util.zip</code> package of the Java class
             library.</p>
 
-          <p>The ar, cpio, tar and zip formats are supported as
+          <p>The ar, cpio, dump, tar and zip formats are supported as
             archivers where the <a href="zip.html">zip</a>
             implementation provides capabilities that go beyond the
-            features found in java.util.zip.</p>
+            features found in java.util.zip.  As of Commons Compress
+            1.3 support for the dump format is read-only.</p>
 
           <p>The compress component provides abstract base classes for
             compressors and archivers together with factories that can



Mime
View raw message