Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

8297605: improve DelayQueue removal method javadoc #12838

Closed
wants to merge 2 commits into from

Conversation

Martin-Buchholz
Copy link
Member

@Martin-Buchholz Martin-Buchholz commented Mar 2, 2023

Inviting @DougLea and @viktorklang-ora to review.

As usual, I couldn't resist more fiddling.

  • Added missing tests for take, remove(), remove(Object).
  • Improved DelayQueueTest's testing infrastructure
  • added more test assertions
  • linkified new javadoc definitions

Progress

  • Change must be properly reviewed (1 review required, with at least 1 Reviewer)
  • Change requires CSR request JDK-8304686 to be approved
  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue

Issues

  • JDK-8297605: improve DelayQueue removal method javadoc
  • JDK-8304686: improve DelayQueue removal method javadoc (CSR)

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 12838

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/12838.diff

@bridgekeeper
Copy link

bridgekeeper bot commented Mar 2, 2023

👋 Welcome back martin! 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 changed the title JDK-8297605 8297605: DelayQueue javadoc is confusing Mar 2, 2023
@openjdk openjdk bot added the rfr Pull request is ready for review label Mar 2, 2023
@openjdk
Copy link

openjdk bot commented Mar 2, 2023

@Martin-Buchholz The following label will be automatically applied to this pull request:

  • core-libs

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

@openjdk openjdk bot added the core-libs core-libs-dev@openjdk.org label Mar 2, 2023
@mlbridge
Copy link

mlbridge bot commented Mar 2, 2023

Webrevs

@DougLea
Copy link
Contributor

DougLea commented Mar 3, 2023

Thanks. This is overkill, but the wording changes and new tests look OK.

@viktorklang-ora
Copy link
Contributor

@Martin-Buchholz I think the updated documentation is clearer. We need some extra reviewers like @AlanBateman or @pron to sign off :)

@AlanBateman
Copy link
Contributor

/csr

Copy link
Contributor

@AlanBateman AlanBateman left a comment

Choose a reason for hiding this comment

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

Wordy but clear, I think it's okay.

@openjdk
Copy link

openjdk bot commented Mar 16, 2023

@Martin-Buchholz 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:

8297605: improve DelayQueue removal method javadoc

Reviewed-by: alanb

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 426 new commits pushed to the master branch:

  • cccb019: 8304928: Optimize ClassDesc.resolveConstantDesc
  • bdbf8fc: 8303930: Fix ConstantUtils.skipOverFieldSignature void case return value
  • 4a5d7ca: 8305227: [s390x] build broken after JDK-8231349
  • dae1ab3: 8304844: JFR: Missing disk parameter in ActiveRecording event
  • e012685: 8305066: [JVMCI] guarantee(ik->is_initialized()) failed: java/lang/Long$LongCache must be initialized
  • fe42312: 8304820: Statically allocate ObjectSynchronizer mutexes
  • 2f36eb0: 8305323: Update java/net/httpclient/ContentLengthHeaderTest.java to use new HttpTestServer factory methods
  • 049b953: 8305223: IGV: mark osr compiled graphs with [OSR] in the name
  • 345669c: 8302738: IGV: refine 'Simplify graph' filter
  • dea9db2: 8305055: IR check fails on some aarch64 platforms
  • ... and 416 more: https://git.openjdk.org/jdk/compare/1e3c9fd67efd8428f702c7a3e26ac2b60e0fe618...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this 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 ready Pull request is ready to be integrated csr Pull request needs approved CSR before integration labels Mar 16, 2023
@openjdk
Copy link

openjdk bot commented Mar 16, 2023

@AlanBateman has indicated that a compatibility and specification (CSR) request is needed for this pull request.

@Martin-Buchholz please create a CSR request for issue JDK-8297605 with the correct fix version. This pull request cannot be integrated until the CSR request is approved.

@openjdk openjdk bot removed the ready Pull request is ready to be integrated label Mar 16, 2023
@openjdk openjdk bot removed the csr Pull request needs approved CSR before integration label Mar 31, 2023
@Martin-Buchholz Martin-Buchholz changed the title 8297605: DelayQueue javadoc is confusing 8297605: improve DelayQueue removal method javadoc Mar 31, 2023
@openjdk openjdk bot added the ready Pull request is ready to be integrated label Mar 31, 2023
@Martin-Buchholz
Copy link
Member Author

/integrate

@openjdk
Copy link

openjdk bot commented Mar 31, 2023

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

  • cccb019: 8304928: Optimize ClassDesc.resolveConstantDesc
  • bdbf8fc: 8303930: Fix ConstantUtils.skipOverFieldSignature void case return value
  • 4a5d7ca: 8305227: [s390x] build broken after JDK-8231349
  • dae1ab3: 8304844: JFR: Missing disk parameter in ActiveRecording event
  • e012685: 8305066: [JVMCI] guarantee(ik->is_initialized()) failed: java/lang/Long$LongCache must be initialized
  • fe42312: 8304820: Statically allocate ObjectSynchronizer mutexes
  • 2f36eb0: 8305323: Update java/net/httpclient/ContentLengthHeaderTest.java to use new HttpTestServer factory methods
  • 049b953: 8305223: IGV: mark osr compiled graphs with [OSR] in the name
  • 345669c: 8302738: IGV: refine 'Simplify graph' filter
  • dea9db2: 8305055: IR check fails on some aarch64 platforms
  • ... and 416 more: https://git.openjdk.org/jdk/compare/1e3c9fd67efd8428f702c7a3e26ac2b60e0fe618...master

Your commit was automatically rebased without conflicts.

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

openjdk bot commented Mar 31, 2023

@Martin-Buchholz Pushed as commit a565be4.

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

@viktorklang-ora
Copy link
Contributor

Nice work @Martin-Buchholz! 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core-libs core-libs-dev@openjdk.org integrated Pull request has been integrated
4 participants