This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-compress.git
commit c4085d77d7095536fb66caf53134cb5fb42610a2 Author: Gary Gregory <[email protected]> AuthorDate: Thu Oct 19 12:57:08 2023 -0400 Uppercase XZ in documentation --- README.md | 2 +- RELEASE-NOTES.txt | 6 +++--- pom.xml | 2 +- src/changes/changes.xml | 2 +- src/changes/release-notes.vm | 2 +- .../commons/compress/compressors/CompressorStreamFactory.java | 6 +++--- .../commons/compress/compressors/CompressorStreamProvider.java | 2 +- .../java/org/apache/commons/compress/compressors/xz/XZUtils.java | 3 ++- src/site/xdoc/examples.xml | 4 ++-- 9 files changed, 15 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 5163265a..808fac7e 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ Apache Commons Compress Apache Commons Compress defines an API for working with compression and archive formats. These include: bzip2, gzip, pack200, -LZMA, xz, Snappy, traditional Unix Compress, DEFLATE, DEFLATE64, LZ4, +LZMA, XZ, Snappy, traditional Unix Compress, DEFLATE, DEFLATE64, LZ4, Brotli, Zstandard and ar, cpio, jar, tar, zip, dump, 7z, arj. Documentation diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt index 293ba54d..48006a1e 100644 --- a/RELEASE-NOTES.txt +++ b/RELEASE-NOTES.txt @@ -2,7 +2,7 @@ Apache Commons Compress defines an API for working with compression and archive formats. These include: bzip2, gzip, pack200, -LZMA, xz, Snappy, traditional Unix Compress, DEFLATE, DEFLATE64, LZ4, +LZMA, XZ, Snappy, traditional Unix Compress, DEFLATE, DEFLATE64, LZ4, Brotli, Zstandard and ar, cpio, jar, tar, zip, dump, 7z, arj. New features: @@ -36,7 +36,7 @@ Download it from https://commons.apache.org/compress/download_compress.cgi Apache Commons Compress defines an API for working with compression and archive formats. These include: bzip2, gzip, pack200, -LZMA, xz, Snappy, traditional Unix Compress, DEFLATE, DEFLATE64, LZ4, +LZMA, XZ, Snappy, traditional Unix Compress, DEFLATE, DEFLATE64, LZ4, Brotli, Zstandard and ar, cpio, jar, tar, zip, dump, 7z, arj. New features: @@ -393,7 +393,7 @@ o Checked the sizes read for archive entries and reject archives several formats. Issue: COMPRESS-569. o OSGi detection was broken and so we always cached whether - xz/brotli/zstd/LZMA have been available even in OSGi + XZ/brotli/zstd/LZMA have been available even in OSGi environments. Issue: COMPRESS-552. o SevenZFile.getEntries now return a copy of entries. diff --git a/pom.xml b/pom.xml index 3e191245..79108093 100644 --- a/pom.xml +++ b/pom.xml @@ -32,7 +32,7 @@ <description> Apache Commons Compress defines an API for working with compression and archive formats. These include: bzip2, gzip, pack200, -LZMA, xz, Snappy, traditional Unix Compress, DEFLATE, DEFLATE64, LZ4, +LZMA, XZ, Snappy, traditional Unix Compress, DEFLATE, DEFLATE64, LZ4, Brotli, Zstandard and ar, cpio, jar, tar, zip, dump, 7z, arj. </description> diff --git a/src/changes/changes.xml b/src/changes/changes.xml index 8b19ad66..d3a55211 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -643,7 +643,7 @@ you relied on the recovery attempt."> </action> <action issue="COMPRESS-552" type="fix" date="2021-03-07"> OSGi detection was broken and so we always cached whether - xz/brotli/zstd/LZMA have been available even in OSGi + XZ/brotli/zstd/LZMA have been available even in OSGi environments. </action> <action issue="COMPRESS-571" type="fix" date="2021-03-17"> diff --git a/src/changes/release-notes.vm b/src/changes/release-notes.vm index f38f9657..9ac3d32e 100644 --- a/src/changes/release-notes.vm +++ b/src/changes/release-notes.vm @@ -459,7 +459,7 @@ o Checked the sizes read for archive entries and reject archives several formats. Issue: COMPRESS-569. o OSGi detection was broken and so we always cached whether - xz/brotli/zstd/LZMA have been available even in OSGi + XZ/brotli/zstd/LZMA have been available even in OSGi environments. Issue: COMPRESS-552. o SevenZFile.getEntries now return a copy of entries. 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 302f6fc8..ba8c877f 100644 --- a/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java +++ b/src/main/java/org/apache/commons/compress/compressors/CompressorStreamFactory.java @@ -474,7 +474,7 @@ public class CompressorStreamFactory implements CompressorStreamProvider { * if true, decompress until the end of the input; if false, stop * after the first stream and leave the input position to point * to the next byte after the stream. This setting applies to the - * gzip, bzip2 and xz formats only. + * gzip, bzip2 and XZ formats only. * @since 1.10 */ public CompressorStreamFactory(final boolean decompressUntilEOF) { @@ -488,7 +488,7 @@ public class CompressorStreamFactory implements CompressorStreamProvider { * if true, decompress until the end of the input; if false, stop * after the first stream and leave the input position to point * to the next byte after the stream. This setting applies to the - * gzip, bzip2 and xz formats only. + * gzip, bzip2 and XZ formats only. * * @param memoryLimitInKb * Some streams require allocation of potentially significant @@ -752,7 +752,7 @@ public class CompressorStreamFactory implements CompressorStreamProvider { * supporting multiple concatenated input streams. * * <p> - * This setting applies to the gzip, bzip2 and xz formats only. + * This setting applies to the gzip, bzip2 and XZ formats only. * </p> * * @param decompressConcatenated diff --git a/src/main/java/org/apache/commons/compress/compressors/CompressorStreamProvider.java b/src/main/java/org/apache/commons/compress/compressors/CompressorStreamProvider.java index 8555d53c..1c27745e 100644 --- a/src/main/java/org/apache/commons/compress/compressors/CompressorStreamProvider.java +++ b/src/main/java/org/apache/commons/compress/compressors/CompressorStreamProvider.java @@ -53,7 +53,7 @@ public interface CompressorStreamProvider { * if true, decompress until the end of the input; if false, stop * after the first stream and leave the input position to point * to the next byte after the stream. This setting applies to the - * gzip, bzip2 and xz formats only. + * gzip, bzip2 and XZ formats only. * @return compressor input stream * @throws CompressorException * if the compressor name is not known diff --git a/src/main/java/org/apache/commons/compress/compressors/xz/XZUtils.java b/src/main/java/org/apache/commons/compress/compressors/xz/XZUtils.java index 5803586c..83b57bdd 100644 --- a/src/main/java/org/apache/commons/compress/compressors/xz/XZUtils.java +++ b/src/main/java/org/apache/commons/compress/compressors/xz/XZUtils.java @@ -25,7 +25,8 @@ import org.apache.commons.compress.compressors.FileNameUtil; import org.apache.commons.compress.utils.OsgiUtils; /** - * Utility code for the xz compression format. + * Utility code for the XZ compression format. + * * @ThreadSafe * @since 1.4 */ diff --git a/src/site/xdoc/examples.xml b/src/site/xdoc/examples.xml index 47a423ae..830f8bbe 100644 --- a/src/site/xdoc/examples.xml +++ b/src/site/xdoc/examples.xml @@ -31,7 +31,7 @@ collect multiple entries inside a single (potentially compressed) archive are archiver formats.</p> - <p>The compressor formats supported are gzip, bzip2, xz, LZMA, + <p>The compressor formats supported are gzip, bzip2, XZ, LZMA, Pack200, DEFLATE, Brotli, DEFLATE64, ZStandard and Z, the archiver formats are 7z, ar, arj, cpio, dump, tar and zip. Pack200 is a special case as it can only compress JAR files.</p> @@ -757,7 +757,7 @@ public class ScatterSample { <section name="Compressors"> <subsection name="Concatenated Streams"> - <p>For the bzip2, gzip and xz formats as well as the framed + <p>For the bzip2, gzip and XZ formats as well as the framed lz4 format a single compressed file may actually consist of several streams that will be concatenated by the command line utilities when decompressing
