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

8325001: Typo in the javadocs for the Arena::ofShared method #17653

Closed
wants to merge 1 commit into from

Conversation

minborg
Copy link
Contributor

@minborg minborg commented Jan 31, 2024

This PR fixes a typo in the documentation for the Arena::ofShared.


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-8325001: Typo in the javadocs for the Arena::ofShared method (Bug - P3)

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 17653

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

Using diff file

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

Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Jan 31, 2024

👋 Welcome back pminborg! 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 Jan 31, 2024
@openjdk
Copy link

openjdk bot commented Jan 31, 2024

@minborg 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 Jan 31, 2024
@mlbridge
Copy link

mlbridge bot commented Jan 31, 2024

Webrevs

Copy link
Member

@dfuch dfuch left a comment

Choose a reason for hiding this comment

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

LGTM

@openjdk
Copy link

openjdk bot commented Jan 31, 2024

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

8325001: Typo in the javadocs for the Arena::ofShared method

Reviewed-by: dfuchs

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

  • 5b9b176: 8324174: assert(m->is_entered(current)) failed: invariant
  • 0cc8e5b: 8325042: remove unused JVMDITools test files
  • f292053: 8323621: JDK build should exclude snippet class in java.lang.foreign
  • 62c9530: 8324238: [macOS] java/awt/Frame/ShapeNotSetSometimes/ShapeNotSetSometimes.java fails with the shape has not been applied msg
  • 1f2922a: 8320342: Use PassFailJFrame for TruncatedPopupMenuTest.java
  • 2cd1ba6: 8324981: Shenandoah: Move commit and soft max heap changed methods into heap
  • 1733d2e: 8303374: Implement JEP 455: Primitive Types in Patterns, instanceof, and switch (Preview)
  • 6697160: 8320712: Rewrite BadFactoryTest in pure Java

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 Jan 31, 2024
@minborg
Copy link
Contributor Author

minborg commented Feb 1, 2024

/integrate

@openjdk
Copy link

openjdk bot commented Feb 1, 2024

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

  • cd11059: 8325053: Serial: Move Generation::save_used_region to TenuredGeneration
  • d9331bf: 8324845: management.properties text "interface name" is misleading
  • 68206b5: 8324585: JVM native memory leak in PCKS11-NSS security provider
  • 1aba78f: 8324937: GHA: Avoid multiple test suites per job
  • a663248: 8324668: JDWP process management needs more efficient file descriptor handling
  • a2229b1: 8324838: test_nmt_locationprinting.cpp broken in the gcc windows build
  • 432756b: 8325024: java/security/cert/CertPathValidator/OCSP/OCSPTimeout.java incorrect comment information
  • fe78c0f: 8325022: Incorrect error message on client authentication
  • 5b9b176: 8324174: assert(m->is_entered(current)) failed: invariant
  • 0cc8e5b: 8325042: remove unused JVMDITools test files
  • ... and 6 more: https://git.openjdk.org/jdk/compare/725314fb739e10aa54e224f46d3c71015cf9d158...master

Your commit was automatically rebased without conflicts.

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

openjdk bot commented Feb 1, 2024

@minborg Pushed as commit 6b84f9b.

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

@minborg
Copy link
Contributor Author

minborg commented Feb 1, 2024

/backport jdk22

@openjdk
Copy link

openjdk bot commented Feb 1, 2024

@minborg the backport was successfully created on the branch backport-minborg-6b84f9bb in my personal fork of openjdk/jdk22. To create a pull request with this backport targeting openjdk/jdk22:master, just click the following link:

➡️ Create pull request

The title of the pull request is automatically filled in correctly and below you find a suggestion for the pull request body:

Hi all,

This pull request contains a backport of commit 6b84f9bb from the openjdk/jdk repository.

The commit being backported was authored by Per Minborg on 1 Feb 2024 and was reviewed by Daniel Fuchs.

Thanks!

If you need to update the source branch of the pull then run the following commands in a local clone of your personal fork of openjdk/jdk22:

$ git fetch https://github.com/openjdk-bots/jdk22.git backport-minborg-6b84f9bb:backport-minborg-6b84f9bb
$ git checkout backport-minborg-6b84f9bb
# make changes
$ git add paths/to/changed/files
$ git commit --message 'Describe additional changes made'
$ git push https://github.com/openjdk-bots/jdk22.git backport-minborg-6b84f9bb

Copy link
Contributor

@mcimadamore mcimadamore left a comment

Choose a reason for hiding this comment

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

Ugh - I typed these comments, but forgot to click on the big review button :-(

@@ -258,7 +258,7 @@ static Arena ofConfined() {
}

/**
* {@return a new shared arena} Segments allocated with the global arena can be
* {@return a new shared arena} Segments allocated with the shared arena can be
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* {@return a new shared arena} Segments allocated with the shared arena can be
* {@return a new shared arena} Segments allocated with a shared arena can be

Copy link
Contributor

Choose a reason for hiding this comment

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

There is a similar issue in the javadoc of ofConfined, which also uses the instead of a.

Copy link
Contributor

Choose a reason for hiding this comment

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

Also, I have noted that the javadoc of ofAuto uses a different style - instead of saying "segments allocated with an automatic arena", it says "segments allocated with the returned arena" (in more places). So perhaps we should make these more consistent?

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
3 participants