Skip to content

8222669: Create and use new html.Entity class #2680

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

Closed
wants to merge 2 commits into from

Conversation

amosshi
Copy link
Contributor

@amosshi amosshi commented Apr 25, 2024

Backport of JDK-8222669. The reason is 8222669 is a dependency to JDK-8253700.

  • This PR contains two commits
    • Commit 1: is the git apply change
    • Commit 2: is the manual merge of the .rej files. All changes has two types
      • Add missing import, or re-organize the import section based on the original commit
      • Change Contents.SPACE to Entity.NO_BREAK_SPACE based on the original commit

Sample manual merge file

  • NestedClassWriterImpl.java.rej
@@ -32,6 +32,7 @@
 import javax.lang.model.element.TypeElement;
 
 import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
+import jdk.javadoc.internal.doclets.formats.html.markup.Entity;
 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
 import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
@@ -154,7 +155,7 @@
                     : resources.getText("doclet.Nested_Classes_Interfaces_Inherited_From_Class"));
         }
         Content labelHeading = HtmlTree.HEADING(Headings.TypeDeclaration.SUMMARY_HEADING, label);
-        labelHeading.add(Contents.SPACE);
+        labelHeading.add(Entity.NO_BREAK_SPACE);
         labelHeading.add(classLink);
         inheritedTree.add(labelHeading);
     }

Testing

  • Local: Test passed on MacOS 14.4.1
    • dev-8222669-11/test/langtools/jdk/javadoc/doclet: Test results: passed: 191
  • Pipeline: All checks have passed
  • Testing Machine: SAP nightlies passed on 2024-04-27
    • jdk/javadoc/doclet/5093723/T5093723.java: SUCCESSFUL GitHub 📊⏲ - [58,605 msec]
    • jdk/javadoc/doclet/AccessAsciiArt/AccessAsciiArt.java: SUCCESSFUL GitHub 📊⏲ - [38,695 msec]
    • jdk/javadoc/doclet/AccessSummary/AccessSummary.java: SUCCESSFUL GitHub 📊⏲ - [44,981 msec]
    • jdk/javadoc/doclet/ValidHtml/ValidHtml.java: SUCCESSFUL GitHub 📊⏲ - [4,706 msec]
    • jdk/javadoc/doclet/VersionNumber/VersionNumber.java: SUCCESSFUL GitHub 📊⏲ - [2,702 msec]
    • ...

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
  • JDK-8222669 needs maintainer approval

Issue

  • JDK-8222669: Create and use new html.Entity class (Enhancement - P3)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 2680

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

Using diff file

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

Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Apr 25, 2024

👋 Welcome back ashi! 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
Copy link

openjdk bot commented Apr 25, 2024

❗ This change is not yet ready to be integrated.
See the Progress checklist in the description for automated requirements.

@openjdk openjdk bot changed the title Backport 761466699c82aa45054b805d7177e8605651ec9d 8222669: Create and use new html.Entity class Apr 25, 2024
@openjdk
Copy link

openjdk bot commented Apr 25, 2024

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

@openjdk openjdk bot added backport rfr Pull request is ready for review labels Apr 25, 2024
@mlbridge
Copy link

mlbridge bot commented Apr 25, 2024

Webrevs

@amosshi
Copy link
Contributor Author

amosshi commented Apr 29, 2024

This backport has been cancelled

@amosshi amosshi closed this Apr 29, 2024
@amosshi amosshi deleted the backport-8222669 branch April 29, 2024 21:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport rfr Pull request is ready for review
Development

Successfully merging this pull request may close these issues.

1 participant