Skip to content

Conversation

@kevinrushforth
Copy link
Member

@kevinrushforth kevinrushforth commented Aug 18, 2023

This PR bumps the limit for the number of javadoc warnings and error from 100 to 1000.

We currently use the default setting of javadoc which only shows 100 warnings and errors. This is too small, especially for warnings, and can cause us to miss new warnings that arise. Eventually we should fix all our warnings, and we have a task filed to track that, but even then I think the limit is too small.

Without this fix, our current build only shows the "first" 100 warnings it runs into. With this fix, our current build shows all 187 warnings using JDK 19.0.2 and all 191 warnings using JDK 21.


Progress

  • Change must be properly reviewed (1 review required, with at least 1 Reviewer)
  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue

Issue

  • JDK-8314589: javadoc build only shows the first 100 warnings and errors (Bug - P4)

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jfx.git pull/1216/head:pull/1216
$ git checkout pull/1216

Update a local copy of the PR:
$ git checkout pull/1216
$ git pull https://git.openjdk.org/jfx.git pull/1216/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 1216

View PR using the GUI difftool:
$ git pr show -t 1216

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jfx/pull/1216.diff

Webrev

Link to Webrev Comment

@kevinrushforth
Copy link
Member Author

@andy-goryachev-oracle can you review?

@nlisker You might also want to take a look.

@bridgekeeper
Copy link

bridgekeeper bot commented Aug 18, 2023

👋 Welcome back kcr! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

@openjdk openjdk bot added the rfr Ready for review label Aug 18, 2023
@mlbridge
Copy link

mlbridge bot commented Aug 18, 2023

Webrevs

@andy-goryachev-oracle
Copy link
Contributor

andy-goryachev-oracle commented Aug 18, 2023

why I am getting only 91 warnings?

edit: gradle javadoc on mac, java 18 (may be that's why).
It's missing, for example this:

jfx/modules/javafx.base/src/main/java/javafx/beans/property/ReadOnlyListWrapper.java:39: warning: no @param for <E>

Copy link
Contributor

@andy-goryachev-oracle andy-goryachev-oracle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

excellent.

@openjdk
Copy link

openjdk bot commented Aug 18, 2023

@kevinrushforth This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8314589: javadoc build only shows the first 100 warnings and errors

Reviewed-by: angorya

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been no new commits pushed to the master branch. If another commit should be pushed before you perform the /integrate command, your PR will be automatically rebased. If you prefer to avoid any potential automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

@openjdk openjdk bot added the ready Ready to be integrated label Aug 18, 2023
@kevinrushforth
Copy link
Member Author

why I am getting only 91 warnings?

edit: gradle javadoc on mac, java 18 (may be that's why).

Very likely. Btw, our CI builds (for releases) and GHA builds use JDK 19.0.2.

JDK 19 added more checks (so we get 187 warnings). JDK 21 also added more checks (we're up to 191).

@nlisker
Copy link
Collaborator

nlisker commented Aug 19, 2023

I didn't test it, but I took a look and the fix seems fine.

@kevinrushforth
Copy link
Member Author

/integrate

@openjdk
Copy link

openjdk bot commented Aug 28, 2023

Going to push as commit 53682dd.
Since your change was applied there have been 3 commits pushed to the master branch:

  • be2c7ae: 8312058: Documentation improvements for subscription based listeners
  • 6a7c743: 8274932: Render scales in EmbeddedWindow are not properly updated
  • 2e937bb: 8313956: focusWithin on parents of a newly-added focused node is not updated

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Aug 28, 2023
@openjdk openjdk bot closed this Aug 28, 2023
@openjdk openjdk bot removed ready Ready to be integrated rfr Ready for review labels Aug 28, 2023
@openjdk
Copy link

openjdk bot commented Aug 28, 2023

@kevinrushforth Pushed as commit 53682dd.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

@kevinrushforth kevinrushforth deleted the 8314589-javadoc-warn-1000 branch August 28, 2023 13:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

integrated Pull request has been integrated

Development

Successfully merging this pull request may close these issues.

3 participants