Repository: commons-compress Updated Branches: refs/heads/master 495712ce6 -> 099cdc213
COMPRESS-423 it's Zstandard not ZStandard Project: http://git-wip-us.apache.org/repos/asf/commons-compress/repo Commit: http://git-wip-us.apache.org/repos/asf/commons-compress/commit/099cdc21 Tree: http://git-wip-us.apache.org/repos/asf/commons-compress/tree/099cdc21 Diff: http://git-wip-us.apache.org/repos/asf/commons-compress/diff/099cdc21 Branch: refs/heads/master Commit: 099cdc213efa00355f3b6d968423b8ef09fede47 Parents: 495712c Author: Stefan Bodewig <bode...@apache.org> Authored: Tue Oct 17 21:07:25 2017 +0200 Committer: Stefan Bodewig <bode...@apache.org> Committed: Tue Oct 17 21:07:25 2017 +0200 ---------------------------------------------------------------------- pom.xml | 2 +- src/changes/changes.xml | 2 +- .../compress/compressors/CompressorStreamFactory.java | 4 ++-- .../commons/compress/compressors/zstandard/package.html | 4 ++-- src/site/xdoc/examples.xml | 6 +++--- src/site/xdoc/index.xml | 10 +++++----- src/site/xdoc/limitations.xml | 6 +++--- 7 files changed, 17 insertions(+), 17 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/commons-compress/blob/099cdc21/pom.xml ---------------------------------------------------------------------- diff --git a/pom.xml b/pom.xml index 6a500c1..bdaa7a7 100644 --- a/pom.xml +++ b/pom.xml @@ -33,7 +33,7 @@ Apache Commons Compress software defines an API for working with compression and archive formats. These include: bzip2, gzip, pack200, lzma, xz, Snappy, traditional Unix Compress, DEFLATE, LZ4, Brotli, -ZStandard and ar, cpio, jar, tar, zip, dump, 7z, arj. +Zstandard and ar, cpio, jar, tar, zip, dump, 7z, arj. </description> <properties> http://git-wip-us.apache.org/repos/asf/commons-compress/blob/099cdc21/src/changes/changes.xml ---------------------------------------------------------------------- diff --git a/src/changes/changes.xml b/src/changes/changes.xml index 68c383e..8854b6c 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -46,7 +46,7 @@ The <action> type attribute can be add,update,fix,remove. description="Release 1.16"> <action issue="COMPRESS-423" type="add" date="2017-10-17" due-to="Andre F de Miranda"> - Add read-only support for ZStandard compression based on the + Add read-only support for Zstandard compression based on the Zstd-jni project. </action> </release> http://git-wip-us.apache.org/repos/asf/commons-compress/blob/099cdc21/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java b/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java index 8b25611..ea32223 100644 --- a/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java +++ b/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java @@ -193,7 +193,7 @@ public class CompressorStreamFactory implements CompressorStreamProvider { public static final String LZ4_FRAMED = "lz4-framed"; /** - * Constant (value {@value}) used to identify the ZStandard compression + * Constant (value {@value}) used to identify the Zstandard compression * algorithm. Not supported as an output stream type. * * @since 1.16 @@ -571,7 +571,7 @@ public class CompressorStreamFactory implements CompressorStreamProvider { if (ZSTANDARD.equalsIgnoreCase(name)) { if (!ZstdUtils.isZstdCompressionAvailable()) { - throw new CompressorException("ZStandard compression is not available."); + throw new CompressorException("Zstandard compression is not available."); } return new ZstdCompressorInputStream(in); } http://git-wip-us.apache.org/repos/asf/commons-compress/blob/099cdc21/src/main/java/org/apache/commons/compress/compressors/zstandard/package.html ---------------------------------------------------------------------- diff --git a/src/main/java/org/apache/commons/compress/compressors/zstandard/package.html b/src/main/java/org/apache/commons/compress/compressors/zstandard/package.html index f9c47ec..1c105ab 100644 --- a/src/main/java/org/apache/commons/compress/compressors/zstandard/package.html +++ b/src/main/java/org/apache/commons/compress/compressors/zstandard/package.html @@ -19,8 +19,8 @@ --> <body> <p>Provides stream class for decompressing streams using the - ZStandard algorithm based - on <a href="https://github.com/luben/zstd-jni">ZStandard + Zstandard algorithm based + on <a href="https://github.com/luben/zstd-jni">Zstandard JNI</a>.</p> </body> </html> http://git-wip-us.apache.org/repos/asf/commons-compress/blob/099cdc21/src/site/xdoc/examples.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/examples.xml b/src/site/xdoc/examples.xml index 87c18bb..6bac23a 100644 --- a/src/site/xdoc/examples.xml +++ b/src/site/xdoc/examples.xml @@ -82,7 +82,7 @@ CompressorInputStream input = new CompressorStreamFactory() .createCompressorInputStream(originalInput); ]]></source> - <p>Note that there is no way to detect the lzma, ZStandard or Brotli formats so only + <p>Note that there is no way to detect the lzma, Zstandard or Brotli formats so only the two-arg version of <code>createCompressorInputStream</code> can be used. Prior to Compress 1.9 the .Z format hasn't been auto-detected @@ -884,9 +884,9 @@ in.close(); </subsection> - <subsection name="ZStandard"> + <subsection name="Zstandard"> - <p>Uncompressing a given ZStandard compressed file (you would + <p>Uncompressing a given Zstandard compressed file (you would certainly add exception handling and make sure all streams get closed properly):</p> <source><![CDATA[ http://git-wip-us.apache.org/repos/asf/commons-compress/blob/099cdc21/src/site/xdoc/index.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml index 84f5aff..6218475 100644 --- a/src/site/xdoc/index.xml +++ b/src/site/xdoc/index.xml @@ -28,7 +28,7 @@ The Apache Commons Compress library defines an API for working with ar, cpio, Unix dump, tar, zip, gzip, XZ, Pack200, bzip2, 7z, arj, lzma, snappy, DEFLATE, lz4, - Brotli, ZStandard and Z files. + Brotli, Zstandard and Z files. </p> <p> The code in this component has many origins: @@ -68,7 +68,7 @@ <subsection name="What's coming in 1.16?"> <ul> - <li>Read-only support for ZStandard compression.</li> + <li>Read-only support for Zstandard compression.</li> </ul> </subsection> @@ -84,7 +84,7 @@ usually correspond to single files or directories.</p> <p>Currently the bzip2, Pack200, XZ, gzip, lzma, brotli, - ZStandard and Z formats are + Zstandard and Z formats are supported as compressors where gzip support is mostly provided by the <code>java.util.zip</code> package and Pack200 support by the <code>java.util.jar</code> package of the Java @@ -92,9 +92,9 @@ domain <a href="http://tukaani.org/xz/java.html">XZ for Java</a> library. Brotli support is provided by the MIT licensed <a href="https://github.com/google/brotli">Google - Brotli decoder</a>. ZStandard support is provided by the BSD + Brotli decoder</a>. Zstandard support is provided by the BSD licensed <a href="https://github.com/luben/zstd-jni">Zstd-jni</a>. - As of Commons Compress 1.16 support for the Z, ZStandard + As of Commons Compress 1.16 support for the Z, Zstandard and Brotli formats is read-only.</p> <p>The ar, arj, cpio, dump, tar, 7z and zip formats are supported as http://git-wip-us.apache.org/repos/asf/commons-compress/blob/099cdc21/src/site/xdoc/limitations.xml ---------------------------------------------------------------------- diff --git a/src/site/xdoc/limitations.xml b/src/site/xdoc/limitations.xml index af8a3f4..18b5b66 100644 --- a/src/site/xdoc/limitations.xml +++ b/src/site/xdoc/limitations.xml @@ -194,14 +194,14 @@ different versions of Java.</li> </ul> </section> - <section name="ZStandard"> + <section name="Zstandard"> <ul> <li>the format requires the otherwise optional <a - href="https://github.com/luben/zstd-jni">ZStandard JNI</a> + href="https://github.com/luben/zstd-jni">Zstandard JNI</a> library.</li> <li>read-only support</li> <li><code>CompressorStreamFactory</code> is not able to auto-detect - streams using ZStandard compression.</li> + streams using Zstandard compression.</li> </ul> </section> </body>