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 2025/11/08 03:04:38 UTC

(commons-compress) branch master updated: Javadoc

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


The following commit(s) were added to refs/heads/master by this push:
     new ce5793afa Javadoc
ce5793afa is described below

commit ce5793afa681f4ebcb2390f715f77ad0984bd7be
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Fri Nov 7 22:04:33 2025 -0500

    Javadoc
    
    Use emphasis instead of italics
---
 .github/workflows/maven.yml                                 | 13 ++++---------
 .../commons/compress/harmony/pack200/Pack200Exception.java  |  2 +-
 2 files changed, 5 insertions(+), 10 deletions(-)

diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml
index dba5ae7c6..570a58b49 100644
--- a/.github/workflows/maven.yml
+++ b/.github/workflows/maven.yml
@@ -36,15 +36,10 @@ jobs:
         java: [ 8, 11, 17, 21, 25 ]
         experimental: [false]
         # Keep the same parameter order as the matrix above
-        #
-        # PMD does not yet support Java 26 (see https://github.com/pmd/pmd/issues/5871).
-        # It is therefore too soon to run tests with Java 26.
-        # Uncomment the following lines once the above issue has been resolved.
-        #
-        # include:
-        #   - os: ubuntu-latest
-        #     java: 26-ea
-        #     experimental: true
+        include:
+           - os: ubuntu-latest
+             java: 26-ea
+             experimental: true
         
     steps:
     - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
diff --git a/src/main/java/org/apache/commons/compress/harmony/pack200/Pack200Exception.java b/src/main/java/org/apache/commons/compress/harmony/pack200/Pack200Exception.java
index 94a30bb2f..cab66177b 100644
--- a/src/main/java/org/apache/commons/compress/harmony/pack200/Pack200Exception.java
+++ b/src/main/java/org/apache/commons/compress/harmony/pack200/Pack200Exception.java
@@ -147,7 +147,7 @@ public Pack200Exception(final String message, final Object... args) {
     /**
      * Constructs an {@code Pack200Exception} with the specified detail message and cause.
      * <p>
-     * Note that the detail message associated with {@code cause} is <i>not</i> automatically incorporated into this exception's detail message.
+     * Note that the detail message associated with {@code cause} is <em>not</em> automatically incorporated into this exception's detail message.
      * </p>
      *
      * @param message The detail message (which is saved for later retrieval by the {@link #getMessage()} method)


Re: (commons-compress) branch master updated: Javadoc

Posted by "Piotr P. Karwasz" <pi...@mailing.copernik.eu>.
Hi Gary,

On 11.11.2025 12:21, Gary Gregory wrote:
> On Tue, Nov 11, 2025 at 3:48 AM Piotr P. Karwasz
> <pi...@mailing.copernik.eu> wrote:
>> - The change disabling JDK 26-ea runs was submitted by me as a PR and
>>   approved by Sebb [1], representing a two-party review and agreement.
> 
> Then I am -1 that change, as it is an obvious mistake or
> misunderstanding of what GitHub _experimental_ builds are.


You are, of course, free to veto the change and we can discuss its
merits. However, silently reverting it without any explanation is not
acceptable practice.


> As I've outlined in the (recent) past many times, _all_ EA builds
> are marked _experimental_ in all of Commons:
> - Lang should not be different from all other components in this regard.


For clarity, this discussion concerns Compress, not Lang.


> - The comment is wrong since the build has been passing using PMD on
> Java 26, this alone should invalidate disabling the experimental
> build.


That is not the case. The most recent build on `master` [1] clearly
shows a PMD failure:

[INFO] --- pmd:3.28.0:pmd (pmd) @ commons-compress ---
[INFO] PMD version: 7.17.0
Error:  Parsing failed in ParseLock#doParse() of ClassStub:java/lang/String
java.lang.IllegalArgumentException: Unsupported class file major version 70
    at org.objectweb.asm.ClassReader.<init> (ClassReader.java:200)
    at org.objectweb.asm.ClassReader.<init> (ClassReader.java:180)
    at org.objectweb.asm.ClassReader.<init> (ClassReader.java:166)
    at org.objectweb.asm.ClassReader.<init> (ClassReader.java:288)
    at
net.sourceforge.pmd.lang.java.symbols.internal.asm.ClassStub$1.doParse
(ClassStub.java:98)

As we all know, this indicates that PMD 7.17.0 depends on an ASM version
that does not yet support Java 26. Updating ASM or PMD will resolve the
issue.

However, neither of those updates was made before re-enabling the
workflow. As a result, the build now reports false positives like those
seen in [2]. Apparently, even GitBox or GitHub don’t fully grasp what
“experimental” means here.


> - This allows us to detect problems _early_ in our own code and in the
> FOSS ecosystem at large. We can then feedback into other projects
> (which I often do).
> - They don't break the other builds in the matrix


Honestly, Gary, what kind of feedback can we provide if the build
appears red regardless of any unit test results? Without checking the
details, one cannot tell whether the experiment itself works or if it’s
simply failing due to external tooling limitations.

Piotr

[1]
https://github.com/apache/commons-compress/actions/runs/19197689377/job/54881035193
[2] https://lists.apache.org/thread/8zxz6q9sj252o9o092hjg0gprf9z8gkn


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Re: (commons-compress) branch master updated: Javadoc

Posted by Gary Gregory <ga...@gmail.com>.
On Tue, Nov 11, 2025 at 3:48 AM Piotr P. Karwasz
<pi...@mailing.copernik.eu> wrote:
>
> Hi Gary,
>
> On 8.11.2025 04:04, ggregory@apache.org wrote:
> >     Javadoc
> >
> >     Use emphasis instead of italics
> > ---
> >  .github/workflows/maven.yml                                 | 13 ++++---------
> >  .../commons/compress/harmony/pack200/Pack200Exception.java  |  2 +-
> >  2 files changed, 5 insertions(+), 10 deletions(-)
> >
> > diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml
> > index dba5ae7c6..570a58b49 100644
> > --- a/.github/workflows/maven.yml
> > +++ b/.github/workflows/maven.yml
> > @@ -36,15 +36,10 @@ jobs:
> >          java: [ 8, 11, 17, 21, 25 ]
> >          experimental: [false]
> >          # Keep the same parameter order as the matrix above
> > -        #
> > -        # PMD does not yet support Java 26 (see https://github.com/pmd/pmd/issues/5871).
> > -        # It is therefore too soon to run tests with Java 26.
> > -        # Uncomment the following lines once the above issue has been resolved.
> > -        #
> > -        # include:
> > -        #   - os: ubuntu-latest
> > -        #     java: 26-ea
> > -        #     experimental: true
> > +        include:
> > +           - os: ubuntu-latest
> > +             java: 26-ea
> > +             experimental: true
>
>
> This is exactly the kind of situation that undermines trust in the CTR
> process:
>
> - The change disabling JDK 26-ea runs was submitted by me as a PR and
>   approved by Sebb [1], representing a two-party review and agreement.

Then I am -1 that change, as it is an obvious mistake or
misunderstanding of what GitHub _experimental_ builds are. As I've
outlined in the (recent) past many times, _all_ EA builds are marked
_experimental_ in all of Commons:
- Lang should not be different from all other components in this regard.
- The comment is wrong since the build has been passing using PMD on
Java 26, this alone should invalidate disabling the experimental
build.
- This allows us to detect problems _early_ in our own code and in the
FOSS ecosystem at large. We can then feedback into other projects
(which I often do).
- They don't break the other builds in the matrix

HTH,
Gary

> - In this commit titled “Javadoc”, the JDK 26-ea configuration was
>   reintroduced:
>   - If this was unintentional, it represents a significant oversight.
>   - If it was intentional, it effectively and silently reverts a
>     reviewed and agreed-upon change.
>
> If there are reasons to re-enable JDK 26-ea directly on `master`, it
> would be good to have a commit message explaining the motivation and why
> it’s considered a “trivial” change (since it really isn’t).
>
> Piotr
>
> [1] https://github.com/apache/commons-compress/pull/724
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
>

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Re: (commons-compress) branch master updated: Javadoc

Posted by "Piotr P. Karwasz" <pi...@mailing.copernik.eu>.
Hi Gary,

On 8.11.2025 04:04, ggregory@apache.org wrote:
>     Javadoc
>     
>     Use emphasis instead of italics
> ---
>  .github/workflows/maven.yml                                 | 13 ++++---------
>  .../commons/compress/harmony/pack200/Pack200Exception.java  |  2 +-
>  2 files changed, 5 insertions(+), 10 deletions(-)
> 
> diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml
> index dba5ae7c6..570a58b49 100644
> --- a/.github/workflows/maven.yml
> +++ b/.github/workflows/maven.yml
> @@ -36,15 +36,10 @@ jobs:
>          java: [ 8, 11, 17, 21, 25 ]
>          experimental: [false]
>          # Keep the same parameter order as the matrix above
> -        #
> -        # PMD does not yet support Java 26 (see https://github.com/pmd/pmd/issues/5871).
> -        # It is therefore too soon to run tests with Java 26.
> -        # Uncomment the following lines once the above issue has been resolved.
> -        #
> -        # include:
> -        #   - os: ubuntu-latest
> -        #     java: 26-ea
> -        #     experimental: true
> +        include:
> +           - os: ubuntu-latest
> +             java: 26-ea
> +             experimental: true


This is exactly the kind of situation that undermines trust in the CTR
process:

- The change disabling JDK 26-ea runs was submitted by me as a PR and
  approved by Sebb [1], representing a two-party review and agreement.
- In this commit titled “Javadoc”, the JDK 26-ea configuration was
  reintroduced:
  - If this was unintentional, it represents a significant oversight.
  - If it was intentional, it effectively and silently reverts a
    reviewed and agreed-upon change.

If there are reasons to re-enable JDK 26-ea directly on `master`, it
would be good to have a commit message explaining the motivation and why
it’s considered a “trivial” change (since it really isn’t).

Piotr

[1] https://github.com/apache/commons-compress/pull/724

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org