8332072: Convert package.html files in `java.naming` to package-info.java #19529

nizarbenalla · 2024-06-03T17:26:52Z

Can I please get a review for this small change? The motivation is that javac does not recognize package.html files.

The conversion was simple, I used a script to rename the files, append "*" on the left and remove some HTML tags like <body> and <html>. I did the conversion in place, renaming them in git but with the big amount of change git thinks it's a new file.

I also added a new package-info.java file to javax.naming.ldap.spi. I hope that's fine.

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

Issues

JDK-8332072: Convert package.html files in java.naming to package-info.java (Sub-task - P4)
JDK-8335213: Code snippet in javax.naming.ldap package summary does not compile (Bug - P4)

Reviewers

Aleksei Efimov (@AlekseiEfimov - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 19529

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

Using diff file

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

Webrev

Link to Webrev Comment

…java

bridgekeeper · 2024-06-03T17:27:29Z

👋 Welcome back nbenalla! 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-06-03T17:27:47Z

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

8332072: Convert package.html files in `java.naming` to package-info.java
8335213: Code snippet in javax.naming.ldap package summary does not compile

Reviewed-by: aefimov

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

5a8af2b: 8335615: Clean up left-overs from 8317721
6923a51: 8335607: Serial: Remove unused collection_attempt_is_safe
5866b16: 8335411: RISC-V: Optimize encode_heap_oop when oop is not null
6db4c6a: 8335536: Fix assertion failure in IdealGraphPrinter when append is true
350f9c1: 8322812: Manpage for jcmd is missing JFR.view command
c06b75f: 8335591: Fix -Wzero-as-null-pointer-constant warnings in ConcurrentHashTable
6c84e9c: 8335544: Serial: Remove unused _should_allocate_from_space
4d2f737: 8335357: Delete HotSpotJDKReflection.oopSizeOffset
77a7078: 8335593: Fix -Wzero-as-null-pointer-constant warning in Type_Array ctor
f3f90dc: 8335592: Fix -Wzero-as-null-pointer-constant warnings in RootNode ctor
... and 83 more: https://git.openjdk.org/jdk/compare/4ce8822b6c53b8bd72713f1bfaf6673b91aabea4...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 (@AlekseiEfimov) 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-06-03T17:28:23Z

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

mlbridge · 2024-06-03T18:05:41Z

Webrevs

jddarcy · 2024-06-03T21:29:32Z

I recommend having the new package-info.java files follow the now-current javadoc conventions including:

Using {@code foo} in preference to <code>foo</code>
Using the @snippet tag in preference to <blockquore><pre>
etc.

nizarbenalla · 2024-06-05T01:25:52Z

Sure, I will do it for this one.

nizarbenalla

I have converted this to use some of the now-current javadoc convetions.

nizarbenalla · 2024-06-26T18:08:21Z

src/java.naming/share/classes/javax/naming/ldap/package-info.java

 * // Perform update
 * Context ctx = ectx.createSubsubcontext("cn=newobj");
 *
 * // Get response controls
 * Control[] respCtls = ectx.getResponseControls();
 * if (respCtls != null) {
 *     // Find the one we want
- *     for (int i = 0; i &lt; respCtls; i++) {
+ *     for (int i = 0; i < respCtls.length; i++) {


This is the only change that isn't a direct 1:1 conversion, I hope this ok.

This seems reasonable for what is an obvious but minor bug

The change looks correct to me too.

nizarbenalla · 2024-06-26T19:46:43Z

/solves JDK-8335213

openjdk · 2024-06-26T19:47:42Z

@nizarbenalla
Adding additional issue to solves list: 8335213: Fix code snippet in javax.naming.ldap package summary.

AlekseiEfimov · 2024-06-27T10:27:03Z

src/java.naming/share/classes/javax/naming/ldap/spi/package-info.java

+ * Extends the {@code javax.naming.ldap} package to provide the classes
+ * and interfaces for the Service Provider Interface (SPI) for LDAP


The javax.naming.ldap.spi package only contains SPI classes that can customize DNS lookups when performing LDAP operations. It was added by JDK-8160768/CSR.
Since the package only contains classes related to this SPI maybe we could change the wording to something like this:

Suggested change

* Extends the {@code javax.naming.ldap} package to provide the classes

* and interfaces for the Service Provider Interface (SPI) for LDAP

* Provides the Service Provider Interface for DNS lookups when

* performing LDAP operations.

Thanks, Fixed in 0104e4a

AlekseiEfimov · 2024-06-27T10:28:26Z

src/java.naming/share/classes/javax/naming/ldap/package-info.java

 * // Perform update
 * Context ctx = ectx.createSubsubcontext("cn=newobj");
 *
 * // Get response controls
 * Control[] respCtls = ectx.getResponseControls();
 * if (respCtls != null) {
 *     // Find the one we want
- *     for (int i = 0; i &lt; respCtls; i++) {
+ *     for (int i = 0; i < respCtls.length; i++) {


The change looks correct to me too.

AlekseiEfimov

Package descriptions generated from new package-info.java files look good and have the same content as the ones generated from package.html files. A minor issue - two leftover tags need to be removed:

AlekseiEfimov · 2024-07-02T15:09:49Z

src/java.naming/share/classes/javax/naming/event/package-info.java

+ * <p>
+ * An application, for example, can register its interest in changes to
+ * objects in a context as follows:
+ * <blockquote>


The leftover <blockquote> can be removed:

Suggested change

* <blockquote>

Fixed both in 657ef5c, thank you.

AlekseiEfimov · 2024-07-02T15:09:52Z

src/java.naming/share/classes/javax/naming/event/package-info.java

+ *     }
+ * }
+ * }
+ * </blockquote>


The leftover </blockquote> can be removed:

Suggested change

* </blockquote>

AlekseiEfimov

The latest changes look good to me

nizarbenalla · 2024-07-03T14:27:50Z

Thank you Aleksei for your review!

/integrate

openjdk · 2024-07-03T14:28:23Z

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

AlekseiEfimov · 2024-07-04T12:28:32Z

/sponsor

openjdk · 2024-07-04T12:29:34Z

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

7e378fc: 8335667: Fix simple -Wzero-as-null-pointer-constant warnings in compiler code
ced9906: 8334371: [AIX] Beginning with AIX 7.3 TL1 mmap() supports 64K memory pages
916db07: 8335532: [JVMCI] Export VM_Version::L1_line_size in JVMCI
c0604fb: 8334890: Missing unconditional cross modifying fence in nmethod entry barriers
cf1be87: 8335663: Fix simple -Wzero-as-null-pointer-constant warnings in C2 code
0bb9c76: 8324089: Fix typo in the manual page for "jcmd" (man jcmd)
3e3f83f: 8335385: javac crash on unattributed piece of AST
b20e8c8: 8335397: Improve reliability of TestRecursiveMonitorChurn.java
38a578d: 8334738: os::print_hex_dump should optionally print ASCII
7b894bc: 8332786: When dumping static CDS archives, explicitly assert that we don't use a CDS archive
... and 102 more: https://git.openjdk.org/jdk/compare/4ce8822b6c53b8bd72713f1bfaf6673b91aabea4...master

Your commit was automatically rebased without conflicts.

openjdk · 2024-07-04T12:29:41Z

@AlekseiEfimov @nizarbenalla Pushed as commit 6a47279.

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

8332072: Convert package.html files in java.naming to package-info.…

1e335d2

…java

openjdk bot changed the title ~~8332072 Convert package.html files in java.naming to package-info.java~~ 8332072: Convert package.html files in java.naming to package-info.java Jun 3, 2024

openjdk bot added the core-libs core-libs-dev@openjdk.org label Jun 3, 2024

remove whitespace

768eebf

nizarbenalla marked this pull request as ready for review June 3, 2024 18:01

openjdk bot added the rfr Pull request is ready for review label Jun 3, 2024

nizarbenalla marked this pull request as draft June 6, 2024 10:11

openjdk bot removed the rfr Pull request is ready for review label Jun 6, 2024

nizarbenalla added 2 commits June 26, 2024 13:15

Merge remote-tracking branch 'upstream/master' into naming

224e071

use javadoc standards

1826633

nizarbenalla commented Jun 26, 2024

View reviewed changes

nizarbenalla marked this pull request as ready for review June 26, 2024 18:08

openjdk bot added the rfr Pull request is ready for review label Jun 26, 2024

AlekseiEfimov reviewed Jun 27, 2024

View reviewed changes

Improve package description based on Efimov's suggestion

0104e4a

AlekseiEfimov suggested changes Jul 2, 2024

View reviewed changes

remove two unnecessary tags

657ef5c

AlekseiEfimov approved these changes Jul 3, 2024

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Jul 3, 2024

openjdk bot added the sponsor Pull request is ready to be sponsored label Jul 3, 2024

openjdk bot added the integrated Pull request has been integrated label Jul 4, 2024

openjdk bot closed this Jul 4, 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 Jul 4, 2024

nizarbenalla deleted the naming branch September 19, 2024 00:29

		* Extends the {@code javax.naming.ldap} package to provide the classes
		* and interfaces for the Service Provider Interface (SPI) for LDAP

8332072: Convert package.html files in java.naming to package-info.java #19529

8332072: Convert package.html files in java.naming to package-info.java #19529

Uh oh!

Conversation

nizarbenalla commented Jun 3, 2024 • edited by openjdk bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Progress

Issues

Reviewers

Reviewing

Webrev

Uh oh!

bridgekeeper bot commented Jun 3, 2024

Uh oh!

openjdk bot commented Jun 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openjdk bot commented Jun 3, 2024

Uh oh!

mlbridge bot commented Jun 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Webrevs

Uh oh!

jddarcy commented Jun 3, 2024

Uh oh!

nizarbenalla commented Jun 5, 2024

Uh oh!

nizarbenalla left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nizarbenalla commented Jun 26, 2024

Uh oh!

openjdk bot commented Jun 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AlekseiEfimov left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AlekseiEfimov left a comment

Choose a reason for hiding this comment

Uh oh!

nizarbenalla commented Jul 3, 2024

Uh oh!

openjdk bot commented Jul 3, 2024

Uh oh!

AlekseiEfimov commented Jul 4, 2024

Uh oh!

openjdk bot commented Jul 4, 2024

Uh oh!

openjdk bot commented Jul 4, 2024

Uh oh!

Uh oh!

8332072: Convert package.html files in `java.naming` to package-info.java #19529

8332072: Convert package.html files in `java.naming` to package-info.java #19529

nizarbenalla commented Jun 3, 2024 •

edited by openjdk bot

Loading

openjdk bot commented Jun 3, 2024 •

edited

Loading

mlbridge bot commented Jun 3, 2024 •

edited

Loading

openjdk bot commented Jun 26, 2024 •

edited

Loading