8342469: Improve API documentation for java.lang.classfile.instruction

[liach]

Hi all,

This pull request contains a backport of commit 0f035545 from the openjdk/jdk repository.

This is a noreg-doc backport - these additions are clarifications to the ClassFile API's java.lang.classfile.instruction package, and are permissible in RDP1 and RDP2.

The commit being backported was authored by Chen Liang on 10 Dec 2024 and was reviewed by Adam Sotona and Joe Darcy.

Thanks!

---

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-8344373 to be approved

Issues

• JDK-8342469: Improve API documentation for java.lang.classfile.instruction (Sub-task - P4)
• JDK-8344373: Improve API documentation for java.lang.classfile.instruction (CSR)

Reviewers

• Adam Sotona (@asotona - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 22671

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

Using diff file

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

Using Webrev

Link to Webrev Comment

[bridgekeeper]

👋 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]

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

8342469: Improve API documentation for java.lang.classfile.instruction

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 1 new commit pushed to the jdk24 branch:

• 4ecb28c: 8344924: Default CA certificates loaded despite request to use custom keystore

Please see this link for an up-to-date comparison between the source branch of this pull request and the jdk24 branch.
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 jdk24 branch, type /integrate in a new comment.

[openjdk]

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

[openjdk]

@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]

Webrevs

• 00: Full (0345cdd8)

[liach]

Thanks for the reviews!

/integrate

[openjdk]

Going to push as commit 03bdee0.
Since your change was applied there has been 1 commit pushed to the jdk24 branch:

• 4ecb28c: 8344924: Default CA certificates loaded despite request to use custom keystore

Your commit was automatically rebased without conflicts.

[openjdk]

@liach Pushed as commit 03bdee0.

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