JDK-8296287: Improve documentation for Types.directSupertypes() by jddarcy · Pull Request #10977 · openjdk/jdk

jddarcy · 2022-11-04T05:46:28Z

Please review the PR and CSR (https://bugs.openjdk.org/browse/JDK-8296354) to add text to explicitly specify the behavior of Types.directSupertypes on java.lang.Object.

(This text could be added as informative text as it is implied by the existing specification, but I think it was reasonable to add the text as a normative statement instead.)

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
Change requires a CSR request to be approved

Issues

JDK-8296287: Improve documentation for Types.directSupertypes()
JDK-8296354: Improve documentation for Types.directSupertypes() (CSR)

Reviewers

Jan Lahoda (@lahodaj - Reviewer) ⚠️ Review applies to e216112e
Pavel Rappo (@pavelrappo - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 10977

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

Using diff file

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

bridgekeeper · 2022-11-04T05:48:38Z

👋 Welcome back darcy! 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 · 2022-11-04T05:51:25Z

@jddarcy The following label will be automatically applied to this pull request:

compiler

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 · 2022-11-04T05:55:05Z

Webrevs

01: Full - Incremental (26ac86b8)
00: Full (e216112e)

lahodaj

Looks good to me.

lahodaj · 2022-11-04T09:06:03Z

test/langtools/tools/javac/processing/model/util/types/TestDirectSupertypeObject.java

+                           RoundEnvironment roundEnv) {
+        if (!roundEnv.processingOver()) {
+            TypeMirror objectType  = requireNonNull(eltUtils.getTypeElement("java.lang.Object")).asType();
+            var ojectSupertypes = typeUtils.directSupertypes(objectType);


Nit: objectSupertypes -> objectSupertypes.

ojectSupertypes

Thanks; will fix before pushing.

pavelrappo · 2022-11-04T11:17:54Z

test/langtools/tools/javac/processing/model/util/types/TestDirectSupertypeObject.java

+/*
+ * @test
+ * @bug 8296287
+ * @summary Test Types methods on module and package TypeMirrors


I don't think I understand the summary. Specifically, how are modules and packages pertinent to this test? (I'm not an expert in compiler area.)

Ah, that was a left over from copying the other test in that directory; will correct to an accurate summary.

pavelrappo · 2022-11-04T11:18:55Z

test/langtools/tools/javac/processing/model/util/types/TestDirectSupertypeObject.java

+    public boolean process(Set<? extends TypeElement> annotations,
+                           RoundEnvironment roundEnv) {
+        if (!roundEnv.processingOver()) {
+            TypeMirror objectType  = requireNonNull(eltUtils.getTypeElement("java.lang.Object")).asType();


Redundant whitespace before =

openjdk · 2022-11-04T16:14:21Z

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

8296287: Improve documentation for Types.directSupertypes()

Reviewed-by: jlahoda, prappo

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

f9c7cda: 8294109: JavaDoc search should search whole index
5622b09: 8200337: Generalize see and link tags for user-defined anchors
22347e4: 8277775: Fixup bugids in RemoveDropTargetCrashTest.java - add 4357905
1231682: 8296305: Remove unimplemented deoptimized_wrt_marked_nmethods
3378bfe: 8296224: G1: Remove unnecessary update in VM_G1CollectForAllocation
8ee0f7d: 8296231: Fix MEMFLAGS for CHeapBitMaps
bd729e6: 8296380: IGV: Shortcut for quick search not working
c116ae7: 8295967: RISC-V: Support negVI/negVL instructions for Vector API
9d3b4ef: 8296108: (tz) Update Timezone Data to 2022f
4d1bc1b: 8296285: test/hotspot/jtreg/compiler/intrinsics/TestFloatIsFinite.java fails after JDK-8280378
... and 1 more: https://git.openjdk.org/jdk/compare/8f6c0489117d1912d15a670c6ca056391e31286d...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.

pavelrappo

Looks good.

jddarcy · 2022-11-04T16:21:06Z

/integrate

openjdk · 2022-11-04T16:22:22Z

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

f9c7cda: 8294109: JavaDoc search should search whole index
5622b09: 8200337: Generalize see and link tags for user-defined anchors
22347e4: 8277775: Fixup bugids in RemoveDropTargetCrashTest.java - add 4357905
1231682: 8296305: Remove unimplemented deoptimized_wrt_marked_nmethods
3378bfe: 8296224: G1: Remove unnecessary update in VM_G1CollectForAllocation
8ee0f7d: 8296231: Fix MEMFLAGS for CHeapBitMaps
bd729e6: 8296380: IGV: Shortcut for quick search not working
c116ae7: 8295967: RISC-V: Support negVI/negVL instructions for Vector API
9d3b4ef: 8296108: (tz) Update Timezone Data to 2022f
4d1bc1b: 8296285: test/hotspot/jtreg/compiler/intrinsics/TestFloatIsFinite.java fails after JDK-8280378
... and 1 more: https://git.openjdk.org/jdk/compare/8f6c0489117d1912d15a670c6ca056391e31286d...master

Your commit was automatically rebased without conflicts.

openjdk · 2022-11-04T16:22:46Z

@jddarcy Pushed as commit 97c5a64.

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

JDK-8296287: Improve documentation for Types.directSupertypes()

e216112

openjdk bot added csr Pull request needs approved CSR before integration rfr Pull request is ready for review labels Nov 4, 2022

openjdk bot added the compiler compiler-dev@openjdk.org label Nov 4, 2022

lahodaj approved these changes Nov 4, 2022

View reviewed changes

pavelrappo reviewed Nov 4, 2022

View reviewed changes

openjdk bot removed the csr Pull request needs approved CSR before integration label Nov 4, 2022

openjdk bot added the ready Pull request is ready to be integrated label Nov 4, 2022

Respond to review feedback.

26ac86b

pavelrappo approved these changes Nov 4, 2022

View reviewed changes

openjdk bot added the integrated Pull request has been integrated label Nov 4, 2022

openjdk bot closed this Nov 4, 2022

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Nov 4, 2022

jddarcy deleted the JDK-8296287 branch June 10, 2023 20:12

Conversation

jddarcy commented Nov 4, 2022 • edited by openjdk bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Progress

Issues

Reviewers

Reviewing

Uh oh!

bridgekeeper bot commented Nov 4, 2022

Uh oh!

openjdk bot commented Nov 4, 2022

Uh oh!

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

Uh oh!

Webrevs

Uh oh!

lahodaj left a comment

Choose a reason for hiding this comment

Uh oh!

lahodaj Nov 4, 2022

Choose a reason for hiding this comment

Uh oh!

pavelrappo Nov 4, 2022

Choose a reason for hiding this comment

Uh oh!

jddarcy Nov 4, 2022

Choose a reason for hiding this comment

Uh oh!

pavelrappo Nov 4, 2022

Choose a reason for hiding this comment

Uh oh!

jddarcy Nov 4, 2022

Choose a reason for hiding this comment

Uh oh!

pavelrappo Nov 4, 2022

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Uh oh!

pavelrappo left a comment

Choose a reason for hiding this comment

Uh oh!

jddarcy commented Nov 4, 2022

Uh oh!

openjdk bot commented Nov 4, 2022

Uh oh!

openjdk bot commented Nov 4, 2022

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

jddarcy commented Nov 4, 2022 •

edited by openjdk bot

Loading

mlbridge bot commented Nov 4, 2022 •

edited

Loading

openjdk bot commented Nov 4, 2022 •

edited

Loading