Author: bodewig
Date: Thu Feb 11 16:13:43 2010
New Revision: 909051
URL: http://svn.apache.org/viewvc?rev=909051&view=rev
Log:
document the format supported by tar. COMPRESS-17.
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/package.html
commons/proper/compress/trunk/src/site/xdoc/examples.xml
Modified:
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/package.html
URL:
http://svn.apache.org/viewvc/commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/package.html?rev=909051&r1=909050&r2=909051&view=diff
==============================================================================
---
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/package.html
(original)
+++
commons/proper/compress/trunk/src/main/java/org/apache/commons/compress/archivers/tar/package.html
Thu Feb 11 16:13:43 2010
@@ -20,5 +20,11 @@
<body>
<p>Provides stream classes for reading and writing archives using
the TAR format.</p>
+
+ <p>There are many different format dialects that call themselves
+ TAR. The classes of this package can read and write archives in
+ the traditional pre-POSIX <b>ustar</b> format and support GNU
+ specific extensions for long filenames that GNU tar itself by
+ now refers to as <b>oldgnu</b>.</p>
</body>
</html>
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=909051&r1=909050&r2=909051&view=diff
==============================================================================
--- commons/proper/compress/trunk/src/site/xdoc/examples.xml (original)
+++ commons/proper/compress/trunk/src/site/xdoc/examples.xml Thu Feb 11
16:13:43 2010
@@ -113,16 +113,19 @@
<p>There are several different tar formats and the TAR package
of Compress 1.0 only provides the common functionality of
the existing variants.</p>
- <p>The original format didn't support file names longer than
- 100 characters and the tar package will fail if you try to
- add an entry longer than that.
+ <p>The original format (often called "ustar") didn't support
+ file names longer than 100 characters and the tar package
+ will fail if you try to add an entry longer than that.
The <code>longFileMode</code> option
of <code>TarArchiveOutputStream</code> can be used to make
- the archive truncate such names or use the GNU tar variant
- of storing such names. If you choose the GNU tar option,
- the archive can not be extracted using many other tar
- implementations like the ones of OpenBSD, Solaris or MacOS
- X.</p>
+ the archive truncate such names or use a GNU tar variant now
+ refered to as "oldgnu" of storing such names. If you choose
+ the GNU tar option, the archive can not be extracted using
+ many other tar implementations like the ones of OpenBSD,
+ Solaris or MacOS X.</p>
+ <p>The tar package does not support the full POSIX tar
+ standard nor more modern GNU extension of said standard. It
+ cannot deal with entries larger than 2 GByte either.</p>
<p><code>TarArchiveInputStream</code> will recognize the GNU
tar extension for long file names and read the longer names
