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

JDK-8313253: Rename methods in javadoc Comparators class #15057

Closed

Conversation

jonathan-gibbons
Copy link
Contributor

@jonathan-gibbons jonathan-gibbons commented Jul 27, 2023

Please review a fairly simple change, to simply rename methods in the Comparators class, to remove the make prefix from the method names, and (for consistency) in one case, remove get. There are some updates to the more problematic javadoc comments as well.

It would be nice to think that the implementation of some methods could be improved by chaining use of simpler standard comparators, but that would be a different task.


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

Issue

  • JDK-8313253: Rename methods in javadoc Comparators class (Enhancement - P4)

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 15057

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

Using diff file

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

Webrev

Link to Webrev Comment

Rename methods in javadoc Comparators class
@bridgekeeper
Copy link

bridgekeeper bot commented Jul 27, 2023

👋 Welcome back jjg! 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 Jul 27, 2023
@openjdk
Copy link

openjdk bot commented Jul 27, 2023

@jonathan-gibbons The following label will be automatically applied to this pull request:

  • javadoc

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 javadoc javadoc-dev@openjdk.org label Jul 27, 2023
@mlbridge
Copy link

mlbridge bot commented Jul 27, 2023

Webrevs

Copy link
Member

@hns hns 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
Copy link

openjdk bot commented Jul 28, 2023

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

8313253: Rename methods in javadoc Comparators class

Reviewed-by: hannesw, prappo

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

  • 47c4b99: 8312121: Fix -Wconversion warnings in tribool.hpp
  • a3d6723: 8311033: [macos] PrinterJob does not take into account Sides attribute
  • 4ae5a3e: 8306446: java/lang/management/ThreadMXBean/Locks.java transient failures
  • cad6114: 8304954: SegmentedCodeCache fails when using large pages
  • ba645da: 8313082: Enable CreateCoredumpOnCrash for testing in makefiles
  • c27c877: 8302017: Allocate BadPaddingException only if it will be thrown
  • c55d29f: 8312626: Resolve multiple definition of 'start_timer' when statically linking JDK native libraries with user code

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

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Jul 28, 2023
@hns
Copy link
Member

hns commented Jul 28, 2023

@jonathan-gibbons I also suspect comparators can be unified/simplified. There is a JBS issue for this and I plan to look into this soon. https://bugs.openjdk.org/browse/JDK-8256984

Copy link
Member

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

@jonathan-gibbons
Copy link
Contributor Author

/integrate

@openjdk
Copy link

openjdk bot commented Jul 28, 2023

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

  • e897041: 8312262: Klass::array_klass() should return ArrayKlass pointer
  • a9a3463: 8312416: Tests in Locale should have more descriptive names
  • d9559f9: 8312612: handle WideCharToMultiByte return values
  • 34173ff: 8312574: jdk/jdk/jfr/jvm/TestChunkIntegrity.java fails with timeout
  • 47c4b99: 8312121: Fix -Wconversion warnings in tribool.hpp
  • a3d6723: 8311033: [macos] PrinterJob does not take into account Sides attribute
  • 4ae5a3e: 8306446: java/lang/management/ThreadMXBean/Locks.java transient failures
  • cad6114: 8304954: SegmentedCodeCache fails when using large pages
  • ba645da: 8313082: Enable CreateCoredumpOnCrash for testing in makefiles
  • c27c877: 8302017: Allocate BadPaddingException only if it will be thrown
  • ... and 1 more: https://git.openjdk.org/jdk/compare/0ca2bfd77960a84486d10d910aa47b2aa9c14e22...master

Your commit was automatically rebased without conflicts.

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

openjdk bot commented Jul 28, 2023

@jonathan-gibbons Pushed as commit 4ae75ca.

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

@jonathan-gibbons jonathan-gibbons deleted the 8313253.comparators branch July 28, 2023 16:40
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 javadoc javadoc-dev@openjdk.org
3 participants