Skip to content

8273045: Fix misc javadoc bugs in the java.security and javax.net.ssl code #5271

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

Closed
wants to merge 2 commits into from

Conversation

bradfordwetmore
Copy link
Contributor

@bradfordwetmore bradfordwetmore commented Aug 27, 2021

Did a quick sweep of some minor non-standard javadoc issues. This silences 3rd party tooling warnings and fixes some linkage issues.


Progress

  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue
  • Change must be properly reviewed

Issue

  • JDK-8273045: Fix misc javadoc bugs in the java.security and javax.net.ssl code

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.java.net/jdk pull/5271/head:pull/5271
$ git checkout pull/5271

Update a local copy of the PR:
$ git checkout pull/5271
$ git pull https://git.openjdk.java.net/jdk pull/5271/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 5271

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.java.net/jdk/pull/5271.diff

@bridgekeeper
Copy link

bridgekeeper bot commented Aug 27, 2021

👋 Welcome back wetmore! 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 Pull request is ready for review label Aug 27, 2021
@openjdk
Copy link

openjdk bot commented Aug 27, 2021

@bradfordwetmore The following labels will be automatically applied to this pull request:

  • net
  • security

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

@openjdk openjdk bot added security security-dev@openjdk.org net net-dev@openjdk.org labels Aug 27, 2021
@mlbridge
Copy link

mlbridge bot commented Aug 27, 2021

Webrevs

Copy link
Member

@XueleiFan XueleiFan 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. Thank you for the clean up.

@@ -34,6 +34,7 @@
import java.util.Locale;
import java.util.Objects;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;
Copy link
Member

Choose a reason for hiding this comment

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

Does it mean that the classes introduced in java doc should also be imported? Maybe, the path package names could be removed in the createSNIMatcher() method spec.

-     * @throws java.util.regex.PatternSyntaxException if the regular expression's
-     *         syntax is invalid
+     * @throws PatternSyntaxException if the regular expression's syntax is invalid

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the catch.

It doesn't absolutely have to be fixed to get javadoc to run (it apparently is a good guesser), but 3rd party tools like IntelliJ Idea aren't as robust, and treat this as an error.

In the second update, I removed the extra package name in setSNIMatcher.

Thanks for the review. I'll go ahead and push.

@openjdk
Copy link

openjdk bot commented Aug 27, 2021

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

8273045: Fix misc javadoc bugs in the java.security and javax.net.ssl code

Reviewed-by: xuelei

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 Pull request is ready to be integrated label Aug 27, 2021
@bradfordwetmore
Copy link
Contributor Author

/integrate

@openjdk
Copy link

openjdk bot commented Aug 27, 2021

Going to push as commit 76baace.
Since your change was applied there has been 1 commit pushed to the master branch:

  • b16a04e: 8271186: Add UL option to replace newline char

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot closed this Aug 27, 2021
@openjdk openjdk bot added integrated Pull request has been integrated and removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Aug 27, 2021
@openjdk
Copy link

openjdk bot commented Aug 27, 2021

@bradfordwetmore Pushed as commit 76baace.

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

@bradfordwetmore bradfordwetmore deleted the JDK-8273045 branch November 17, 2021 18:25
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 net net-dev@openjdk.org security security-dev@openjdk.org
Development

Successfully merging this pull request may close these issues.

2 participants