Skip to content

Remove Javadoc 1.4+ / -1.1 switch related warning - #1240

Merged
olamy merged 5 commits into
apache:masterfrom
perceptron8:patch-1
Aug 20, 2025
Merged

olamy merged 5 commits into
apache:masterfrom
perceptron8:patch-1

Conversation

@perceptron8

Copy link
Copy Markdown
Contributor

This commit reverts the behavior introduced in d3fbbda, after which a warning about the -1.1 switch appears unconditionally. The warning, "Javadoc 1.4+ doesn't support the -1.1 switch anymore. Ignore this option." now only displays if the old parameter is set to true, as it did previously.


This commit reverts the behavior introduced in d3fbbda, after which a warning about the `-1.1` switch appears unconditionally.
The warning, "Javadoc 1.4+ doesn't support the -1.1 switch anymore. Ignore this option." now only displays if the `old` parameter is set to true, as it did previously.
@olamy

olamy commented Aug 18, 2025 •

Copy link
Copy Markdown
Member

can you please provide an IT test for this as I'm not really sure to understand the problem.

@perceptron8

Copy link
Copy Markdown
Contributor Author

Sure! Here it is: it.zip.

Compare

mvn clean org.apache.maven.plugins:maven-javadoc-plugin:3.11.2:jar

with

mvn clean org.apache.maven.plugins:maven-javadoc-plugin:3.11.3:jar

In case of 3.11.3 you will get:

[WARNING] Javadoc 1.4+ doesn't support the -1.1 switch anymore. Ignore this option.

The warning shouldn't be displayed when old is false (which is the default setting).

Signed-off-by: Olivier Lamy <olamy@apache.org>
@olamy

olamy commented Aug 19, 2025

Copy link
Copy Markdown
Member

Thanks.
I have modifiied an IT test for your change in this PR.

@olamy olamy added the bug Something isn't working label Aug 19, 2025
@olamy olamy self-assigned this Aug 19, 2025
@olamy olamy added this to the 3.11.4 milestone Aug 19, 2025
@perceptron8

Copy link
Copy Markdown
Contributor Author

Could we add another test? This one would check if assert log.count(...) == 1 passes for old = true. The existing test will pass not only when there is no warning, but also if the warning is displayed with slightly different wording. If the message is altered in the future, this test won't be a reliable check.

@olamy

olamy commented Aug 19, 2025

Copy link
Copy Markdown
Member

Could we add another test? This one would check if assert log.count(...) == 1 passes for old = true. The existing test will pass not only when there is no warning, but also if the warning is displayed with slightly different wording. If the message is altered in the future, this test won't be a reliable check.

sure feel free to add more tests and let me know when you're done then I will merge the PR

@perceptron8

Copy link
Copy Markdown
Contributor Author

It seems that this would require a completely new integration test (with a separate pom.xml, invoker.properties, etc., for example, in MJAVADOC-770_old). It appears that MJAVADOC-770* is not a good place at all to test whether the old-related warning appears (this IT seems to be testing the legacyMode parameter instead). Therefore, I wanted to propose removing the assertion you added. In its current form, it's not very useful (for the reason I presented in my previous comment). Adding another test with positive case just for checking a minor warning is probably an overkill.

@olamy

olamy commented Aug 19, 2025

Copy link
Copy Markdown
Member

It seems that this would require a completely new integration test (with a separate pom.xml, invoker.properties, etc., for example, in MJAVADOC-770_old). It appears that MJAVADOC-770* is not a good place at all to test whether the old-related warning appears (this IT seems to be testing the legacyMode parameter instead). Therefore, I wanted to propose removing the assertion you added. In its current form, it's not very useful (for the reason I presented in my previous comment). Adding another test with positive case just for checking a minor warning is probably an overkill.

sure go for it. maybe just create a new IT as you can see it's very easy :)

@perceptron8

Copy link
Copy Markdown
Contributor Author

Ok, I'll clean up MJAVADOC-770 and add 2 old-related ITs.

@perceptron8 perceptron8 changed the title Make Javadoc -1.1 switch related warning conditional again Remove Javadoc 1.4+ / -1.1 switch related warning Aug 19, 2025
@perceptron8

Copy link
Copy Markdown
Contributor Author

Please do squash the first 4 commits when merging (hopefully). I didn't want to force-push to avoid disrupting your review of the PR.

@olamy

olamy commented Aug 19, 2025

Copy link
Copy Markdown
Member

@perceptron8 Thanks. I'm waiting for all CI builds to pass then will merge it.

@olamy
olamy merged commit 71a6ca4 into apache:master Aug 20, 2025
@olamy olamy modified the milestones: 3.11.4, 3.12.0 Aug 27, 2025
odl-github pushed a commit to opendaylight/odlparent that referenced this pull request Aug 27, 2025
This reverts commit c3803c8, as it
issues a new warning as detailed in
apache/maven-javadoc-plugin#1240.

Change-Id: I8a6962674644532304dedf12292e0d8b814baf62
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants