Skip to content
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

8295653: Add a graph of the sealed class hierarchy for marked classes #10761

Closed

Conversation

magicus
Copy link
Member

@magicus magicus commented Oct 19, 2022

It would be possible to mark classes with @sealedGraph to indicate that the sealed hierarchy should be rendered graphically in the JavaDocs. Classes not marked would be unaffected, creating an opt-in approach.

Here is an example of MemoryLayout class rendering.

This feature has been developed in cooperation with Per Minborg.


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-8295653: Add a graph of the sealed class hierarchy for marked classes

Reviewers

Contributors

  • Per Minborg <pminborg@openjdk.org>

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 10761

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

Using diff file

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

@openjdk
Copy link

openjdk bot commented Oct 19, 2022

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

  • build
  • javadoc

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.

@openjdk openjdk bot added javadoc javadoc-dev@openjdk.org build build-dev@openjdk.org labels Oct 19, 2022
@mlbridge
Copy link

mlbridge bot commented Oct 19, 2022

Webrevs

@openjdk
Copy link

openjdk bot commented Oct 20, 2022

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

8295653: Add a graph of the sealed class hierarchy for marked classes

Co-authored-by: Per Minborg <pminborg@openjdk.org>
Reviewed-by: erikj, jjg

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

  • 59a13b1: 8295872: [PPC64] JfrGetCallTrace: Need pc == nullptr check before frame constructor
  • 2a79dfc: 8295774: Write a test to verify List sends ItemEvent/ActionEvent
  • cc3c5a1: 8296101: nmethod::is_unloading result unstable with concurrent unloading
  • d771abb: 8295970: Add vector api sanity tests in tier1
  • 7a85441: 8232933: Javac inferred type does not conform to equality constraint
  • 6ee8ccf: 8296168: x86: Add reasonable constraints between AVX and SSE
  • 1950747: 8279913: obsolete ExtendedDTraceProbes
  • 13b20e0: 8296262: Remove dead code from InstanceKlass::signature_name()
  • fd60036: 8296188: Update style and header in JDWP Protocol spec and JVMTI spec
  • c7b95a8: 8296163: [aarch64] Cleanup Pre/Post addressing mode classes
  • ... and 160 more: https://git.openjdk.org/jdk/compare/fc889577eaf3f564d896818c1d9b1eb6fa5a8758...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.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Oct 20, 2022
Copy link
Contributor

@jonathan-gibbons jonathan-gibbons left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor comments, but generally OK

make/Main.gmk Outdated Show resolved Hide resolved
make/jdk/src/classes/build/tools/taglet/SealedGraph.java Outdated Show resolved Hide resolved
make/jdk/src/classes/build/tools/taglet/SealedGraph.java Outdated Show resolved Hide resolved
@magicus
Copy link
Member Author

magicus commented Nov 3, 2022

/integrate

@openjdk
Copy link

openjdk bot commented Nov 3, 2022

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

  • 59a13b1: 8295872: [PPC64] JfrGetCallTrace: Need pc == nullptr check before frame constructor
  • 2a79dfc: 8295774: Write a test to verify List sends ItemEvent/ActionEvent
  • cc3c5a1: 8296101: nmethod::is_unloading result unstable with concurrent unloading
  • d771abb: 8295970: Add vector api sanity tests in tier1
  • 7a85441: 8232933: Javac inferred type does not conform to equality constraint
  • 6ee8ccf: 8296168: x86: Add reasonable constraints between AVX and SSE
  • 1950747: 8279913: obsolete ExtendedDTraceProbes
  • 13b20e0: 8296262: Remove dead code from InstanceKlass::signature_name()
  • fd60036: 8296188: Update style and header in JDWP Protocol spec and JVMTI spec
  • c7b95a8: 8296163: [aarch64] Cleanup Pre/Post addressing mode classes
  • ... and 160 more: https://git.openjdk.org/jdk/compare/fc889577eaf3f564d896818c1d9b1eb6fa5a8758...master

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Nov 3, 2022
@openjdk openjdk bot closed this Nov 3, 2022
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Nov 3, 2022
@openjdk
Copy link

openjdk bot commented Nov 3, 2022

@magicus Pushed as commit b7442d1.

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

@magicus magicus deleted the sealed-hierarchy-JDK-8293865-branch branch November 3, 2022 14:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build build-dev@openjdk.org integrated Pull request has been integrated javadoc javadoc-dev@openjdk.org
Development

Successfully merging this pull request may close these issues.

5 participants