You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2023/10/19 17:20:55 UTC

[commons-compress] 05/09: LZMA is an acronym

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 f2cec930f65125c140032c59835f7a5c3a992ad1
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Thu Oct 19 12:51:26 2023 -0400

    LZMA is an acronym
---
 README.md                                                         | 2 +-
 RELEASE-NOTES.txt                                                 | 6 +++---
 pom.xml                                                           | 2 +-
 src/changes/release-notes.vm                                      | 2 +-
 .../commons/compress/archivers/sevenz/SevenZFileOptions.java      | 8 ++++----
 .../compress/compressors/lzma/LZMACompressorInputStream.java      | 4 ++--
 src/site/xdoc/examples.xml                                        | 8 ++++----
 src/site/xdoc/index.xml                                           | 6 +++---
 8 files changed, 19 insertions(+), 19 deletions(-)

diff --git a/README.md b/README.md
index b19e1709..5163265a 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 ee23a8b6..293ba54d 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 cf378c19..3e191245 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/release-notes.vm b/src/changes/release-notes.vm
index e7b4fae7..f38f9657 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/archivers/sevenz/SevenZFileOptions.java b/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZFileOptions.java
index 67f0e294..642669db 100644
--- a/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZFileOptions.java
+++ b/src/main/java/org/apache/commons/compress/archivers/sevenz/SevenZFileOptions.java
@@ -47,8 +47,8 @@ public class SevenZFileOptions {
          * Sets the maximum amount of memory to use for parsing the
          * archive and during extraction.
          *
-         * <p>Not all codecs will honor this setting. Currently only lzma
-         * and lzma2 are supported.</p>
+         * <p>Not all codecs will honor this setting. Currently only LZMA
+         * and LZMA2 are supported.</p>
          *
          * @param maxMemoryLimitInKb limit of the maximum amount of memory to use
          * @return the reconfigured builder
@@ -131,8 +131,8 @@ public class SevenZFileOptions {
      * Gets the maximum amount of memory to use for parsing the
      * archive and during extraction.
      *
-     * <p>Not all codecs will honor this setting. Currently only lzma
-     * and lzma2 are supported.</p>
+     * <p>Not all codecs will honor this setting. Currently only LZMA
+     * and LZMA2 are supported.</p>
      *
      * @return the maximum amount of memory to use for extraction
      */
diff --git a/src/main/java/org/apache/commons/compress/compressors/lzma/LZMACompressorInputStream.java b/src/main/java/org/apache/commons/compress/compressors/lzma/LZMACompressorInputStream.java
index d68a6dfb..96814a95 100644
--- a/src/main/java/org/apache/commons/compress/compressors/lzma/LZMACompressorInputStream.java
+++ b/src/main/java/org/apache/commons/compress/compressors/lzma/LZMACompressorInputStream.java
@@ -36,13 +36,13 @@ public class LZMACompressorInputStream extends CompressorInputStream
     implements InputStreamStatistics {
 
     /**
-     * Checks if the signature matches what is expected for an lzma file.
+     * Checks if the signature matches what is expected for an LZMA file.
      *
      * @param signature
      *            the bytes to check
      * @param length
      *            the number of bytes to check
-     * @return true, if this stream is an lzma  compressed stream, false otherwise
+     * @return true, if this stream is an LZMA compressed stream, false otherwise
      *
      * @since 1.10
      */
diff --git a/src/site/xdoc/examples.xml b/src/site/xdoc/examples.xml
index 187036be..47a423ae 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>
@@ -82,7 +82,7 @@ CompressorInputStream input = new CompressorStreamFactory()
     .createCompressorInputStream(originalInput);
 ]]></source>
 
-        <p>Note that there is no way to detect the lzma or Brotli formats so only
+        <p>Note that there is no way to detect the LZMA 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
@@ -991,7 +991,7 @@ in.close();
           public domain <a href="https://tukaani.org/xz/java.html">XZ
           for Java</a> library.</p>
 
-        <p>Uncompressing a given lzma compressed file (you would
+        <p>Uncompressing a given LZMA compressed file (you would
           certainly add exception handling and make sure all streams
           get closed properly):</p>
 <source><![CDATA[
@@ -1008,7 +1008,7 @@ out.close();
 lzmaIn.close();
 ]]></source>
 
-        <p>Compressing a given file using lzma (you would
+        <p>Compressing a given file using LZMA (you would
           certainly add exception handling and make sure all streams
           get closed properly):</p>
 <source><![CDATA[
diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml
index 3fef4576..613f53a0 100644
--- a/src/site/xdoc/index.xml
+++ b/src/site/xdoc/index.xml
@@ -27,7 +27,7 @@
             <p>
                 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,
+                Pack200, bzip2, 7z, arj, LZMA, snappy, DEFLATE, lz4,
                 Brotli, Zstandard, DEFLATE64 and Z files.
             </p>
             <p>
@@ -70,11 +70,11 @@
             by <code>ArchiveEntry</code> instances which in turn
             usually correspond to single files or directories.</p>
 
-          <p>Currently the bzip2, Pack200, XZ, gzip, lzma, brotli,
+          <p>Currently the bzip2, Pack200, XZ, gzip, LZMA, brotli,
             Zstandard and Z formats are
             supported as compressors where gzip support is mostly provided by
             the <code>java.util.zip</code> package of the Java
-            class library.  XZ and lzma support is provided by the public
+            class library.  XZ and LZMA support is provided by the public
             domain <a href="https://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