Skip to content

8302214: Typo in javadoc of Arrays.compare and Arrays.mismatch #12488

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 1 commit into from

Conversation

eirbjo
Copy link
Contributor

@eirbjo eirbjo commented Feb 9, 2023

The Javadocs of Arrays.compare and Arrays.mismatch uses the incorrect capitalization atoIndex and btoIndex when referencing the corresponding aToIndex and bToIndex parameters.

Sample:

* specified ranges [{@code aFromIndex}, {@code atoIndex}) and
* [{@code bFromIndex}, {@code btoIndex}) respectively:

This PR changes the capitalization to aToIndex and bToIndex. This change was performed using case-sensitive search / replace in an IDE.


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-8302214: Typo in javadoc of Arrays.compare and Arrays.mismatch

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 12488

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

Using diff file

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

@bridgekeeper
Copy link

bridgekeeper bot commented Feb 9, 2023

👋 Welcome back eirbjo! 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 Feb 9, 2023

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

@openjdk openjdk bot added the core-libs core-libs-dev@openjdk.org label Feb 9, 2023
@jaikiran
Copy link
Member

Hello Eirik, I've create a JBS issue to track this change https://bugs.openjdk.org/browse/JDK-8302214. Please update the title of this PR to 8302214: Typo in javadoc of Arrays.compare and Arrays.mismatch, so that it triggers the official review process.

@eirbjo
Copy link
Contributor Author

eirbjo commented Feb 10, 2023

/issue 8302214

@openjdk openjdk bot changed the title Incorrect capitalization of aToIndex, bToIndex in Arrays Javadocs 8302214: Typo in javadoc of Arrays.compare and Arrays.mismatch Feb 10, 2023
@openjdk
Copy link

openjdk bot commented Feb 10, 2023

@eirbjo The primary solved issue for a PR is set through the PR title. Since the current title does not contain an issue reference, it will now be updated.

@openjdk openjdk bot added the rfr Pull request is ready for review label Feb 10, 2023
@eirbjo
Copy link
Contributor Author

eirbjo commented Feb 10, 2023

Hello Eirik, I've create a JBS issue to track this change https://bugs.openjdk.org/browse/JDK-8302214.

Thanks, title changed!

@mlbridge
Copy link

mlbridge bot commented Feb 10, 2023

Webrevs

Copy link
Member

@jaikiran jaikiran left a comment

Choose a reason for hiding this comment

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

The changes look fine to me.

@openjdk
Copy link

openjdk bot commented Feb 13, 2023

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

8302214: Typo in javadoc of Arrays.compare and Arrays.mismatch

Reviewed-by: jpai

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

  • d1c87a0: 8302203: IR framework should detect non-compilable test methods early
  • 1fec6b5: 8301852: RISC-V: Optimize class atomic when order is memory_order_relaxed
  • 7c233bc: 8302114: RISC-V: Several foreign jtreg tests fail with debug build after JDK-8301818
  • 8049e59: 8301833: Add wide-ranging tests for FDLIBM porting
  • 6a44120: 8301269: Update Commons BCEL to Version 6.7.0
  • 6f9f2b5: 8301737: java/rmi/server/UnicastRemoteObject/serialFilter/FilterUROTest.java fail with -Xcomp
  • 1ef9f65: 8302172: [JVMCI] HotSpotResolvedJavaMethodImpl.canBeInlined must respect ForceInline
  • 74b167b: 8301819: Enable continuations code by default
  • 919a6da: 8301202: Port fdlibm log to Java
  • 98e98e9: 8296322: javac: use methods to manage parser mode flags
  • ... and 63 more: https://git.openjdk.org/jdk/compare/09b8a1959771213cb982d062f0a913285e4a0c6e...master

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.

As you do not have Committer status in this project an existing Committer must agree to sponsor your change. Possible candidates are the reviewers of this PR (@jaikiran) but any other Committer may sponsor as well.

➡️ To flag this PR as ready for integration with the above commit message, type /integrate in a new comment. (Afterwards, your sponsor types /sponsor in a new comment to perform the integration).

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Feb 13, 2023
@eirbjo
Copy link
Contributor Author

eirbjo commented Feb 13, 2023

/integrate

@openjdk openjdk bot added the sponsor Pull request is ready to be sponsored label Feb 13, 2023
@openjdk
Copy link

openjdk bot commented Feb 13, 2023

@eirbjo
Your change (at version 9b4bc93) is now ready to be sponsored by a Committer.

@jaikiran
Copy link
Member

/sponsor

@openjdk
Copy link

openjdk bot commented Feb 14, 2023

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

  • 94e7cc8: 8301226: Add clamp() methods to java.lang.Math and to StrictMath
  • 13b1ebb: 8298853: JvmtiVTMSTransitionDisabler should support disabling one virtual thread transitions
  • abbeb7e: 8302108: Clean up placeholder supername code
  • d503c66: 8302155: [AIX] NUM_LCPU is not required variable
  • c37e9d1: 8298293: NMT: os::realloc() should verify that flags do not change between reallocations
  • 101db26: 8301697: [s390] Optimized-build is broken
  • f4d4fa5: 8300255: Introduce interface for GC oop verification in the assembler
  • 99b6c0e: 8302289: RISC-V: Use bgez instruction in arraycopy_simple_check when possible
  • 57aef85: 8301838: PPC: continuation yield intrinsic: exception check not needed if yield succeeded
  • df93880: 8301942: java/net/httpclient/DigestEchoClientSSL.java fail with -Xcomp
  • ... and 81 more: https://git.openjdk.org/jdk/compare/09b8a1959771213cb982d062f0a913285e4a0c6e...master

Your commit was automatically rebased without conflicts.

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

openjdk bot commented Feb 14, 2023

@jaikiran @eirbjo Pushed as commit d782125.

💡 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
core-libs core-libs-dev@openjdk.org integrated Pull request has been integrated
Development

Successfully merging this pull request may close these issues.

2 participants