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

8267068: Incomplete @throws javadoc for various javax.crypto.spec classes #23188

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

mcpowers
Copy link
Contributor

@mcpowers mcpowers commented Jan 18, 2025

JDK-8267068


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 a CSR request matching fixVersion 25 to be approved (needs to be created)

Issue

  • JDK-8267068: Incomplete @throws javadoc for various javax.crypto.spec classes (Bug - P4)

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 23188

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

Using diff file

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

Using Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Jan 18, 2025

👋 Welcome back mpowers! 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
Copy link

openjdk bot commented Jan 18, 2025

@mcpowers This change is no longer ready for integration - check the PR body for details.

@openjdk
Copy link

openjdk bot commented Jan 18, 2025

@mcpowers The following label will be automatically applied to this pull request:

  • security

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.

@mcpowers mcpowers marked this pull request as ready for review January 18, 2025 03:23
@openjdk openjdk bot added the rfr Pull request is ready for review label Jan 18, 2025
@mlbridge
Copy link

mlbridge bot commented Jan 18, 2025

Webrevs

Copy link
Member

@jnimeh jnimeh left a comment

Choose a reason for hiding this comment

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

Looks good to me.

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Jan 21, 2025
@seanjmullan
Copy link
Member

This will need a CSR because you are adding a new exception to the RC5ParameterSpec constructor.

@seanjmullan
Copy link
Member

/csr

@openjdk openjdk bot added the csr Pull request needs approved CSR before integration label Jan 21, 2025
@openjdk
Copy link

openjdk bot commented Jan 21, 2025

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

@mcpowers please create a CSR request for issue JDK-8267068 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 Jan 21, 2025
@seanjmullan
Copy link
Member

@valeriepeng can you also review this? Thanks.

* @throws ArrayIndexOutOfBoundsException is thrown if <code>offset</code>
* or <code>len</code> index bytes outside the <code>iv</code>.
* @throws ArrayIndexOutOfBoundsException if {@code offset}
* or {@code len} index bytes outside the {@code iv}.
Copy link
Member

Choose a reason for hiding this comment

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

can you fix this grammatical issue while you are changing this:

s/outside/are outside/

@mcpowers
Copy link
Contributor Author

So a CSR is needed even if the only change is to sync javadoc with the code?

@seanjmullan
Copy link
Member

So a CSR is needed even if the only change is to sync javadoc with the code?

Yes, because that is still considered a specification change to a public API.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
csr Pull request needs approved CSR before integration rfr Pull request is ready for review security [email protected]
Development

Successfully merging this pull request may close these issues.

3 participants