jdk icon indicating copy to clipboard operation
jdk copied to clipboard

docs(util): enhanced Properties#list javadoc

Open astrologic7 opened this issue 6 months ago • 8 comments

Trivial PR to enhance Javadoc for the Properties#list method, which has cost me some debugging time.


Progress

  • [ ] Change must be properly reviewed (1 review required, with at least 1 Reviewer)
  • [x] Change must not contain extraneous whitespace
  • [ ] Commit message must refer to an issue

Error

 ⚠️ OCA signatory status must be verified

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 25334

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

Using diff file

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

astrologic7 avatar May 20 '25 16:05 astrologic7

Hi @cagliostro92, welcome to this OpenJDK project and thanks for contributing!

We do not recognize you as Contributor and need to ensure you have signed the Oracle Contributor Agreement (OCA). If you have not signed the OCA, please follow the instructions. Please fill in your GitHub username in the "Username" field of the application. Once you have signed the OCA, please let us know by writing /signed in a comment in this pull request.

If you already are an OpenJDK Author, Committer or Reviewer, please click here to open a new issue so that we can record that fact. Please use "Add GitHub user cagliostro92" as summary for the issue.

If you are contributing this work on behalf of your employer and your employer has signed the OCA, please let us know by writing /covered in a comment in this pull request.

bridgekeeper[bot] avatar May 20 '25 16:05 bridgekeeper[bot]

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

8358530: Properties#list should warn against non-String values

Reviewed-by: jlu, liach

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

  • 594c080b2bde81a48ecccda85ac765218fc93856: 8359760: Remove the jdk.jsobject module
  • e6ebefaa404daa4160bdc1c5d9c954c040e2c0c2: 8333857: Test sun/security/ssl/SSLSessionImpl/ResumeChecksServer.java failed: Existing session was used
  • 38cd860daa9504bbe5add8c2d045d78c75fb7e38: 8363816: Refactor array name creation
  • ... and 115 more: https://git.openjdk.org/jdk/compare/c9ecc826668575678f11578a67f125d430ebffad...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 (@justin-curtis-lu, @liach) 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[bot] avatar May 20 '25 16:05 openjdk[bot]

@cagliostro92 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[bot] avatar May 20 '25 16:05 openjdk[bot]

/signed

astrologic7 avatar May 20 '25 16:05 astrologic7

Thank you! Please allow for up to two weeks to process your OCA, although it is usually done within one to two business days. Also, please note that pull requests that are pending an OCA check will not usually be evaluated, so your patience is appreciated!

bridgekeeper[bot] avatar May 20 '25 16:05 bridgekeeper[bot]

@cagliostro92 This pull request has been inactive for more than 4 weeks and will be automatically closed if another 4 weeks passes without any activity. To avoid this, simply issue a /touch or /keepalive command to the pull request. Feel free to ask for assistance if you need help with progressing this pull request towards integration!

bridgekeeper[bot] avatar Jun 17 '25 20:06 bridgekeeper[bot]

/keepalive

astrologic7 avatar Jun 26 '25 08:06 astrologic7

@cagliostro92 The pull request is being re-evaluated and the inactivity timeout has been reset.

openjdk[bot] avatar Jun 26 '25 08:06 openjdk[bot]

@cagliostro92 Please do not rebase or force-push to an active PR as it invalidates existing review comments. Note for future reference, the bots always squash all changes into a single commit automatically as part of the integration. See OpenJDK Developers’ Guide for more information.

openjdk[bot] avatar Jul 15 '25 09:07 openjdk[bot]

Hi @justin-curtis-lu I've just pushed a new commit following your suggestion. Would be great if you could create a CSR on my behalf. 🙂

astrologic7 avatar Jul 15 '25 09:07 astrologic7

Webrevs

mlbridge[bot] avatar Jul 15 '25 09:07 mlbridge[bot]

/csr

AlanBateman avatar Jul 15 '25 09:07 AlanBateman

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

@cagliostro92 please create a CSR request for issue JDK-8358530 with the correct fix version. This pull request cannot be integrated until the CSR request is approved.

openjdk[bot] avatar Jul 15 '25 09:07 openjdk[bot]

/integrate

astrologic7 avatar Jul 23 '25 15:07 astrologic7

@cagliostro92 Your change (at version a0c7572fbe2b6266dba0d466adba2b1f66ee1cea) is now ready to be sponsored by a Committer.

openjdk[bot] avatar Jul 23 '25 15:07 openjdk[bot]

@justin-curtis-lu Do you want a final round of review?

liach avatar Jul 23 '25 15:07 liach

/sponsor

justin-curtis-lu avatar Jul 23 '25 16:07 justin-curtis-lu

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

  • 594c080b2bde81a48ecccda85ac765218fc93856: 8359760: Remove the jdk.jsobject module
  • e6ebefaa404daa4160bdc1c5d9c954c040e2c0c2: 8333857: Test sun/security/ssl/SSLSessionImpl/ResumeChecksServer.java failed: Existing session was used
  • 38cd860daa9504bbe5add8c2d045d78c75fb7e38: 8363816: Refactor array name creation
  • ... and 115 more: https://git.openjdk.org/jdk/compare/c9ecc826668575678f11578a67f125d430ebffad...master

Your commit was automatically rebased without conflicts.

openjdk[bot] avatar Jul 23 '25 16:07 openjdk[bot]

@justin-curtis-lu @cagliostro92 Pushed as commit 03e9ea169b7e45ae3c2ac23b5fe73d39ae57506f.

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

openjdk[bot] avatar Jul 23 '25 16:07 openjdk[bot]

@justin-curtis-lu @liach thank you! 🙂

astrologic7 avatar Jul 23 '25 16:07 astrologic7