8332071: Convert package.html files in `java.management.rmi` to package-info.java #19263

nizarbenalla · 2024-05-16T10:39:43Z

Please review this change. I converted the package.html file to package-info.java, because javac cannot recognize package.html.
I already brought this up in the mailing list.
The conversion was done in-place, only renaming it in git.

I also added a couple of @since tags, with only 2 changes I don't want to split these two fixes into separate PRs.
CREDENTIALS_FILTER_PATTERN and SERIAL_FILTER_PATTERN were first added in https://bugs.openjdk.org/browse/JDK-8187556

Progress

Change must not contain extraneous whitespace
Commit message must refer to an issue
Change must be properly reviewed (2 reviews required, with at least 1 Reviewer, 1 Author)

Issues

JDK-8332071: Convert package.html files in java.management.rmi to package-info.java (Sub-task - P4)
JDK-8332376: Add @since tags to java.management.rmi (Sub-task - P4)

Reviewers

Kevin Walls (@kevinjwalls - Reviewer) ⚠️ Review applies to 52d3d182
Roger Riggs (@RogerRiggs - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 19263

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

Using diff file

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

Webrev

Link to Webrev Comment

bridgekeeper · 2024-05-16T10:40:07Z

👋 Welcome back nizarbenalla! 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 · 2024-05-16T10:40:50Z

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

8332071: Convert package.html files in `java.management.rmi` to package-info.java
8332376: Add `@since` tags to `java.management.rmi`

Reviewed-by: kevinw, rriggs

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

9ca90cc: 8332610: Remove unused nWakeups in ObjectMonitor
92d3350: 8331920: ubsan: g1CardSetContainers.inline.hpp:266:5: runtime error: index 2 out of bounds for type 'G1CardSetHowl::ContainerPtr [2]' reported
4f1a10f: 8332360: JVM hangs at exit when running on a uniprocessor
c3bc23f: 8326306: RISC-V: Re-structure MASM calls and jumps
8a9d77d: 8320622: [TEST] Improve coverage of compiler/loopopts/superword/TestMulAddS2I.java on different platforms
3d511ff: 8329748: Change default value of AssertWXAtThreadSync to true
67f03f2: 8332533: RISC-V: Enable vector variable shift instructions for machines with RVV
5f804b2: 8329825: Clarify the value type for java.net.SocketOptions.SO_LINGER
52eda79: 8332538: Switch off JIT memory limit check for TestAlignVectorFuzzer.java
d999b81: 8331572: Allow using OopMapCache outside of STW GC phases
... and 98 more: https://git.openjdk.org/jdk/compare/32c7681cf310c87669c502c4a8b62a7fecc93360...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 (@kevinjwalls, @RogerRiggs) 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 · 2024-05-16T10:41:16Z

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

jmx
serviceability

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.

nizarbenalla · 2024-05-16T10:41:26Z

/issue add JDK-8332286

openjdk · 2024-05-16T10:42:22Z

@nizarbenalla
Adding additional issue to issue list: 8332286: Fix the @SInCE tags in java source code documentation.

- Add `@since` tags to RMIConnectorServer

nizarbenalla · 2024-05-18T23:04:25Z

sorry about the force push, had to.

nizarbenalla · 2024-05-19T15:48:37Z

/issue add JDK-8332376

nizarbenalla · 2024-05-19T15:48:46Z

/issue remove JDK-8332286

openjdk · 2024-05-19T15:49:25Z

@nizarbenalla
Adding additional issue to issue list: 8332376: Add @SInCEtags tojava.management.rmi``.

openjdk · 2024-05-19T15:49:48Z

@nizarbenalla
Removing additional issue from issue list: 8332286.

nizarbenalla · 2024-05-19T15:55:42Z

/label remove jmx

openjdk · 2024-05-19T15:56:20Z

@nizarbenalla
The jmx label was successfully removed.

mlbridge · 2024-05-19T16:00:26Z

Webrevs

AlanBateman · 2024-05-19T18:47:50Z

src/java.management.rmi/share/classes/javax/management/remote/rmi/package-info.java

+ * questions.
+ */
+
+/**


I assume you'll need to prepend each line with * too, which has the side effect of making it appear that every line is changed but I think we just need to get over that.

Doing that makes git think it's a new file, rather than a rename.
I was doing this in a26ee08 and removed it

LGTM - there are further potential improvements that could be made in this file - like replacing <code></code> with {@code } and <pre></pre> with {@snippet } but I guess that can wait until someone has the inclination and bandwidth to do it...

Fixed, found how to "lazily" append to the lines I want so adding the " *" wasn't an issue

kevinjwalls

Looks good - with the asterisk * prefix question from the other comment.
I looked to check and yes the since 10 is correct.

kevinjwalls · 2024-05-20T10:32:44Z

/reviewers 2

openjdk · 2024-05-20T10:33:07Z

@kevinjwalls
The total number of required reviews for this PR (including the jcheck configuration and the last /reviewers command) is now set to 2 (with at least 1 Reviewer, 1 Author).

RogerRiggs · 2024-05-20T18:50:08Z

src/java.management.rmi/share/classes/javax/management/remote/rmi/package-info.java

+ *
+ *    @since 1.5
+ *
+ **/


Extra * */ is sufficient.

Fixed in 393bf3a, thanks.

RogerRiggs · 2024-05-20T18:52:58Z

src/java.management.rmi/share/classes/javax/management/remote/rmi/RMIConnectorServer.java

+     *
+     * @since 10
+     */


Please fix the indentation of the "*" for the this comment on CREDENTIALS_FILTER_PATTERN so it looks consistent.

Fixed to be consistent, but the rest of the comment is still indented wrong.

/** * Name of the attribute that specifies ... * ....

(I would have gone the other way and corrected the preceding indentation to the standard).

RogerRiggs

LGTM

nizarbenalla · 2024-05-22T15:44:25Z

/integrate

openjdk · 2024-05-22T15:45:16Z

@nizarbenalla
Your change (at version 82536dd) is now ready to be sponsored by a Committer.

kevinjwalls · 2024-05-22T16:30:34Z

/sponsor

openjdk · 2024-05-22T16:31:19Z

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

afed7d0: 8329538: Accelerate P256 on x86_64 using Montgomery intrinsic
9ca90cc: 8332610: Remove unused nWakeups in ObjectMonitor
92d3350: 8331920: ubsan: g1CardSetContainers.inline.hpp:266:5: runtime error: index 2 out of bounds for type 'G1CardSetHowl::ContainerPtr [2]' reported
4f1a10f: 8332360: JVM hangs at exit when running on a uniprocessor
c3bc23f: 8326306: RISC-V: Re-structure MASM calls and jumps
8a9d77d: 8320622: [TEST] Improve coverage of compiler/loopopts/superword/TestMulAddS2I.java on different platforms
3d511ff: 8329748: Change default value of AssertWXAtThreadSync to true
67f03f2: 8332533: RISC-V: Enable vector variable shift instructions for machines with RVV
5f804b2: 8329825: Clarify the value type for java.net.SocketOptions.SO_LINGER
52eda79: 8332538: Switch off JIT memory limit check for TestAlignVectorFuzzer.java
... and 99 more: https://git.openjdk.org/jdk/compare/32c7681cf310c87669c502c4a8b62a7fecc93360...master

Your commit was automatically rebased without conflicts.

openjdk · 2024-05-22T16:31:25Z

@kevinjwalls @nizarbenalla Pushed as commit a0c5714.

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

openjdk bot added serviceability serviceability-dev@openjdk.org jmx jmx-dev@openjdk.org labels May 16, 2024

nizarbenalla changed the title ~~8332071: Convert package.html files in java.management.rmi to package-info.java~~ 8332071: Convert package.html files in java.management.rmi to package-info.java May 16, 2024

- convert package.html to package-info.java

8a644f3

- Add `@since` tags to RMIConnectorServer

nizarbenalla force-pushed the java-management-rmi branch from a26ee08 to 8a644f3 Compare May 18, 2024 23:03

remove whitespace

52d3d18

openjdk bot removed the jmx jmx-dev@openjdk.org label May 19, 2024

nizarbenalla marked this pull request as ready for review May 19, 2024 15:57

openjdk bot added the rfr Pull request is ready for review label May 19, 2024

AlanBateman reviewed May 19, 2024

View reviewed changes

kevinjwalls approved these changes May 20, 2024

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label May 20, 2024

openjdk bot removed the ready Pull request is ready to be integrated label May 20, 2024

append each line with " *"

e247164

openjdk bot removed the rfr Pull request is ready for review label May 20, 2024

Remove tabs

232a533

openjdk bot added the rfr Pull request is ready for review label May 20, 2024

RogerRiggs reviewed May 20, 2024

View reviewed changes

nizarbenalla added 2 commits May 20, 2024 19:56

suggestions from roger

393bf3a

fix indentation

82536dd

RogerRiggs approved these changes May 22, 2024

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label May 22, 2024

openjdk bot added the sponsor Pull request is ready to be sponsored label May 22, 2024

openjdk bot added the integrated Pull request has been integrated label May 22, 2024

openjdk bot closed this May 22, 2024

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 May 22, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

8332071: Convert package.html files in `java.management.rmi` to package-info.java #19263

8332071: Convert package.html files in `java.management.rmi` to package-info.java #19263

nizarbenalla commented May 16, 2024 •

edited by openjdk bot

bridgekeeper bot commented May 16, 2024

openjdk bot commented May 16, 2024 •

edited

openjdk bot commented May 16, 2024

nizarbenalla commented May 16, 2024

openjdk bot commented May 16, 2024

nizarbenalla commented May 18, 2024

nizarbenalla commented May 19, 2024

nizarbenalla commented May 19, 2024

openjdk bot commented May 19, 2024

openjdk bot commented May 19, 2024

nizarbenalla commented May 19, 2024

openjdk bot commented May 19, 2024

mlbridge bot commented May 19, 2024 •

edited

AlanBateman May 19, 2024

nizarbenalla May 19, 2024

dfuch May 20, 2024 •

edited

nizarbenalla May 20, 2024

kevinjwalls left a comment

kevinjwalls commented May 20, 2024

openjdk bot commented May 20, 2024

RogerRiggs May 20, 2024

nizarbenalla May 20, 2024

RogerRiggs May 20, 2024

nizarbenalla May 20, 2024

RogerRiggs May 20, 2024

RogerRiggs left a comment

nizarbenalla commented May 22, 2024

openjdk bot commented May 22, 2024

kevinjwalls commented May 22, 2024

openjdk bot commented May 22, 2024

openjdk bot commented May 22, 2024

8332071: Convert package.html files in java.management.rmi to package-info.java #19263

8332071: Convert package.html files in java.management.rmi to package-info.java #19263

Conversation

nizarbenalla commented May 16, 2024 • edited by openjdk bot

Progress

Issues

Reviewers

Reviewing

Webrev

bridgekeeper bot commented May 16, 2024

openjdk bot commented May 16, 2024 • edited

openjdk bot commented May 16, 2024

nizarbenalla commented May 16, 2024

openjdk bot commented May 16, 2024

nizarbenalla commented May 18, 2024

nizarbenalla commented May 19, 2024

nizarbenalla commented May 19, 2024

openjdk bot commented May 19, 2024

openjdk bot commented May 19, 2024

nizarbenalla commented May 19, 2024

openjdk bot commented May 19, 2024

mlbridge bot commented May 19, 2024 • edited

Webrevs

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dfuch May 20, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kevinjwalls left a comment

Choose a reason for hiding this comment

kevinjwalls commented May 20, 2024

openjdk bot commented May 20, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

RogerRiggs left a comment

Choose a reason for hiding this comment

nizarbenalla commented May 22, 2024

openjdk bot commented May 22, 2024

kevinjwalls commented May 22, 2024

openjdk bot commented May 22, 2024

openjdk bot commented May 22, 2024

8332071: Convert package.html files in `java.management.rmi` to package-info.java #19263

8332071: Convert package.html files in `java.management.rmi` to package-info.java #19263

nizarbenalla commented May 16, 2024 •

edited by openjdk bot

openjdk bot commented May 16, 2024 •

edited

mlbridge bot commented May 19, 2024 •

edited

dfuch May 20, 2024 •

edited