This is an automated email from the ASF dual-hosted git repository.
bodewig pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-compress.git
commit c832c8d07572e92e5be00f70509d1b911bc009f8
Author: Stefan Bodewig <bode...@apache.org>
AuthorDate: Sat Jul 3 17:39:09 2021 +0200
update documentation
---
src/changes/changes.xml | 15 ++++++++++++---
src/site/xdoc/index.xml | 16 +++++++++++++++-
src/site/xdoc/limitations.xml | 8 ++++++--
src/site/xdoc/tar.xml | 18 ++++++++++++------
4 files changed, 45 insertions(+), 12 deletions(-)
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 5a1364a..35a8cc3 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -42,8 +42,14 @@ The <action> type attribute can be add,update,fix,remove.
<title>Apache Commons Compress Release Notes</title>
</properties>
<body>
- <release version="1.21" date="not released, yet (Java 8)"
- description="Release 1.21">
+ <release version="1.21" date="not released, et"
+ description="Release 1.21 (Java 8)
+----------------------------------------
+
+SevenZFileOptions has a new setting that needs to be enabled explicity
+if SevenZFile should try to recover broken archives - a feature
+introduced with Commons Compress 1.19. This is a breaking change if
+you relied on the recovery attempt.">
<action type="update" date="2020-03-07"
due-to="Peter Alfred Lee">
Made sure ZstdCompressorOutputStream no longer used
@@ -99,7 +105,7 @@ The <action> type attribute can be add,update,fix,remove.
</action>
<action issue="COMPRESS-515" type="fix" date="2020-05-22"
due-to="ian-lavallee">
Add the archive name in the exception in the constructor of
- ZipFIle to make it a more specific exception.
+ ZipFile to make it a more specific exception.
Github Pull Request #102.
</action>
<action issue="COMPRESS-530" type="fix" date="2020-05-26">
@@ -204,6 +210,9 @@ The <action> type attribute can be add,update,fix,remove.
<action type="fix" date="2020-08-22" dev="PeterLee">
Add a new maven profile in pom.xml for JDK14+ to ignore the
failing tests about Pack200.
+
+ This has later been superseeded by adding the Apache Harmony
+ classes for Pack200 support.
</action>
<action issue="COMPRESS-548" type="fix" date="2020-08-24"
due-to="Maksim Zuev" dev="PeterLee">
diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml
index b267cdc..ec333a2 100644
--- a/src/site/xdoc/index.xml
+++ b/src/site/xdoc/index.xml
@@ -52,12 +52,26 @@
</section>
<section name="Status">
- <p>The current release is 1.20 and requires Java 7.</p>
+ <p>The current release is 1.21 and requires Java 8.</p>
<p>Below we highlight some new features, for a full list
of changes see the <a href="changes-report.html">Changes
Report</a>.</p>
+ <subsection name="What's new in 1.21?">
+ <ul>
+ <li>A new class <code>TarFile</code> provides random
+ access to TAR archives.</li>
+ <li>Commons Compress now ships with a copy of the
+ Pack200 code of the retired Apache Harmony project. The
+ pack200 support in Commons Compress no longer uses the
+ implementation of the Java class library - and thus also
+ works for Java 14 and later.</li>
+ <li>Added new methods supporting
+ <code>java.nio.Path</code> as an alternative to
+ <code>java.io.File</code> to many classes.</li>
+ </ul>
+ </subsection>
<subsection name="What's new in 1.20?">
<ul>
<li><code>SevenZFile</code> now supports random
diff --git a/src/site/xdoc/limitations.xml b/src/site/xdoc/limitations.xml
index ea72416..e1c62d1 100644
--- a/src/site/xdoc/limitations.xml
+++ b/src/site/xdoc/limitations.xml
@@ -161,10 +161,14 @@
</section>
<section name="PACK200">
<ul>
- <li>Pack200 support in Commons Comppress relies on the
+ <li><p>Pack200 support in Commons Comppress prior to 1.21 relies on
the
<code>Pack200</code> class of the Java classlib. Java 14
removed support and thus Pack200 will not work at all when
- running on Java 14 or later.</li>
+ running on Java 14 or later.</p>
+ <p>Starting with Commons Compress 1.21 the classlib
+ implementation is no longer used at all, instead Commons
+ Compress contains the pack200 code of the retired Apache
+ Harmony project.</p></li>
</ul>
</section>
<section name="SNAPPY">
diff --git a/src/site/xdoc/tar.xml b/src/site/xdoc/tar.xml
index c17ea8c..79a6943 100644
--- a/src/site/xdoc/tar.xml
+++ b/src/site/xdoc/tar.xml
@@ -126,13 +126,12 @@
<subsection name="Sparse files">
- <p><code>TarArchiveInputStream</code> will recognize sparse
+ <p>Prior to Commons Compress 1.20 <code>TarArchiveInputStream</code>
would recognize sparse
file entries stored using the "oldgnu" format
- (<code>--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>
+ (<code>--sparse-version=0.0</code> in GNU tar) but not
+ able to extract them correctly. Starting with Commons Compress
+ all GNU and POSIX variants of sparse files are recognized and
+ can be raed.</p>
</subsection>
<subsection name="Consuming Archives Completely">
@@ -223,6 +222,13 @@
</ul>
</subsection>
+ <subsection name="Random Access">
+ <p>Starting with Commons Compress 1.21 the tar package
+ contains a <code>TarFile</code> class that provides random
+ access to archives. Except for the ability to access entries
+ out of order <code>TarFile</code> is not superior to
+ <code>TarArchiveInputStream</code>.</p>
+ </subsection>
</section>
</body>
</document>
