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

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

Closed
wants to merge 2 commits into from

Conversation

jddarcy
Copy link
Member

@jddarcy jddarcy commented Nov 4, 2022

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

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
Copy link

bridgekeeper bot commented Nov 4, 2022

👋 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 openjdk bot added csr Pull request needs approved CSR before integration rfr Pull request is ready for review labels Nov 4, 2022
@openjdk
Copy link

openjdk bot commented Nov 4, 2022

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

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

mlbridge bot commented Nov 4, 2022

Webrevs

Copy link
Contributor

@lahodaj lahodaj left a comment

Choose a reason for hiding this comment

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

Looks good to me.

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

Choose a reason for hiding this comment

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

Nit: objectSupertypes -> objectSupertypes.

Copy link
Member

Choose a reason for hiding this comment

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

ojectSupertypes

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks; will fix before pushing.

/*
* @test
* @bug 8296287
* @summary Test Types methods on module and package TypeMirrors
Copy link
Member

Choose a reason for hiding this comment

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

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.)

Copy link
Member Author

Choose a reason for hiding this comment

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

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

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

Choose a reason for hiding this comment

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

Redundant whitespace before =

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

openjdk bot commented Nov 4, 2022

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

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

@pavelrappo pavelrappo left a comment

Choose a reason for hiding this comment

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

Looks good.

@jddarcy
Copy link
Member Author

jddarcy commented Nov 4, 2022

/integrate

@openjdk
Copy link

openjdk bot commented Nov 4, 2022

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 openjdk bot added the integrated Pull request has been integrated label Nov 4, 2022
@openjdk openjdk bot closed this Nov 4, 2022
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Nov 4, 2022
@openjdk
Copy link

openjdk bot commented Nov 4, 2022

@jddarcy Pushed as commit 97c5a64.

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

@jddarcy jddarcy deleted the JDK-8296287 branch June 10, 2023 20:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
compiler compiler-dev@openjdk.org integrated Pull request has been integrated
3 participants