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

[bodewig]

Author: bodewig
Date: Mon Jul 25 05:54:45 2011
New Revision: 1150553

URL: http://svn.apache.org/viewvc?rev=1150553&view=rev
Log:
document limited sparse file support in tar package.  COMPRESS-145

Modified:
    commons/proper/compress/trunk/src/changes/changes.xml
    commons/proper/compress/trunk/src/site/xdoc/examples.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=1150553&r1=1150552&r2=1150553&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/changes/changes.xml (original)
+++ commons/proper/compress/trunk/src/changes/changes.xml Mon Jul 25 05:54:45 
2011
@@ -47,8 +47,9 @@ The <action> type attribute can be add,u
     <release version="1.2" date="as in SVN" description="Release 1.2">
       <action issue="COMPRESS-145" type="fix" date="2011-07-23"
               due-tue="Patrick Dreyer">
-        TarArchiveInputStream now detects sparse entries and properly
-        reports it cannot extract their contents.
+        TarArchiveInputStream now detects sparse entries using the
+        oldgnu format and properly reports it cannot extract their
+        contents.
       </action>
       <action issue="COMPRESS-123" type="add" date="2011-07-23">
         ZipArchiveEntry has a new method getRawName that provides the

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=1150553&r1=1150552&r2=1150553&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/site/xdoc/examples.xml (original)
+++ commons/proper/compress/trunk/src/site/xdoc/examples.xml Mon Jul 25 
05:54:45 2011
@@ -163,6 +163,14 @@ LOOP UNTIL entry.getSize() HAS BEEN READ
           tar extension for long file names and read the longer names
           accordingly.</p>
 
+        <p><code>TarArchiveInputStream</code> will recognize sparse
+          file entries stored using the "oldgnu" format
+          (<code>-&#x2d;sparse-version=0.0</code> in GNU tar) but is
+          not able to extract them correctly.
+          <a href="#Unsupported Features"><code>canReadEntryData</code></a>
+          will return false on such entries.  The other variants of
+          sparse files can currently not be detected at all.</p>
+
         <p>Adding an entry to a tar archive:</p>
 <source><![CDATA[
 TarArchiveEntry entry = new TarArchiveEntry(name);