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

8342468: Improve API documentation for java.lang.classfile.constantpool #23046

Closed
wants to merge 2 commits into from

Conversation

liach
Copy link
Member

@liach liach commented Jan 10, 2025

This is a non-clean backport of bcefab5, because afe5434 which fixes a Javadoc link error was also included in this backport. This backports Javadoc improvements to the ClassFile API committed to mainline back to 24, the finalization release of the ClassFile API.

Running tier 1-3 tests right now.


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
  • Change requires CSR request JDK-8344448 to be approved

Issues

  • JDK-8342468: Improve API documentation for java.lang.classfile.constantpool (Sub-task - P4)
  • JDK-8347163: Javadoc error in ConstantPoolBuilder after JDK-8342468 (Bug - P4)
  • JDK-8344448: Improve API documentation for java.lang.classfile.constantpool (CSR)

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 23046

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

Using diff file

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

Using Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Jan 10, 2025

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

@openjdk
Copy link

openjdk bot commented Jan 10, 2025

@liach 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:

8342468: Improve API documentation for java.lang.classfile.constantpool
8347163: Javadoc error in ConstantPoolBuilder after JDK-8342468

Reviewed-by: asotona

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 jdk24 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 jdk24 branch, type /integrate in a new comment.

@liach
Copy link
Member Author

liach commented Jan 10, 2025

/issue add 8347163

@openjdk openjdk bot changed the title Backport bcefab5e55d4527a38dcab550581a734c1564608 8342468: Improve API documentation for java.lang.classfile.constantpool Jan 10, 2025
@openjdk
Copy link

openjdk bot commented Jan 10, 2025

This backport pull request has now been updated with issue from the original commit.

@openjdk openjdk bot added backport rfr Pull request is ready for review labels Jan 10, 2025
@openjdk
Copy link

openjdk bot commented Jan 10, 2025

@liach
Adding additional issue to issue list: 8347163: Javadoc error in ConstantPoolBuilder after JDK-8342468.

@openjdk
Copy link

openjdk bot commented Jan 10, 2025

@liach 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.

@mlbridge
Copy link

mlbridge bot commented Jan 10, 2025

Webrevs

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Jan 13, 2025
@liach
Copy link
Member Author

liach commented Jan 13, 2025

Thanks for the reviews. There was just one unrelated test failure; integrating.

/integrate

@openjdk
Copy link

openjdk bot commented Jan 13, 2025

Going to push as commit 4a623a2.
Since your change was applied there have been 2 commits pushed to the jdk24 branch:

  • ecdc322: 8339728: [Accessibility,Windows,JAWS] Bug in the getKeyChar method of the AccessBridge class
  • da74fbd: 8347006: LoadRangeNode floats above array guard in arraycopy intrinsic

Your commit was automatically rebased without conflicts.

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

openjdk bot commented Jan 13, 2025

@liach Pushed as commit 4a623a2.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

2 participants