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-8254796: Cleanup pervasive unnecessary parameter #672

Conversation

@jonathan-gibbons
Copy link
Contributor

@jonathan-gibbons jonathan-gibbons commented Oct 14, 2020

This is a small cleanup to remove an annoying extra parameter (docEnv) being based around when creating the doclet.

(there's a hint of the old world too, when it is referred to as "rd" in one place, short for "RootDoc": the corresponding class in the old world ;-) )


Progress

  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue
  • Change must be properly reviewed

Testing

Linux x64 Windows x64 macOS x64
Build ✔️ (5/5 passed) (1/2 failed) ✔️ (2/2 passed)
Test (tier1) ✔️ (9/9 passed) ✔️ (9/9 passed)

Failed test task

Issue

Reviewers

Download

$ git fetch https://git.openjdk.java.net/jdk pull/672/head:pull/672
$ git checkout pull/672

@bridgekeeper
Copy link

@bridgekeeper bridgekeeper bot commented Oct 14, 2020

👋 Welcome back jjg! 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 the rfr label Oct 14, 2020
@openjdk
Copy link

@openjdk openjdk bot commented Oct 14, 2020

@jonathan-gibbons The following label will be automatically applied to this pull request:

  • javadoc

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 javadoc label Oct 14, 2020
@mlbridge
Copy link

@mlbridge mlbridge bot commented Oct 14, 2020

Webrevs

}

void generate() throws DocFileIOException, SimpleDocletException {
if (docEnv == null || outputdir == null) {

This comment has been minimized.

@kusrinivasan

kusrinivasan Oct 16, 2020
Member

Why was it checking for docEnv or RootDoc being null ? Was this ever being called without RootDoc being initialized ?

This comment has been minimized.

@jonathan-gibbons

jonathan-gibbons Oct 19, 2020
Author Contributor

It's hard to believe the value was ever null, at least in normal operation.

Copy link
Member

@kusrinivasan kusrinivasan left a comment

Generally the changes are fine, I had a question about the old world specific to why RootDoc would be null if generate was called, but again the old world had a lot of goofy things going on.

@hns
hns approved these changes Oct 19, 2020
@openjdk
Copy link

@openjdk openjdk bot commented Oct 19, 2020

@jonathan-gibbons 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:

8254796: Cleanup pervasive unnecessary parameter

Reviewed-by: ksrini, hannesw

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

  • 953e472: 8254967: com.sun.net.HttpsServer spins on TLS session close
  • 1da28de: 8255009: delta apply fixes for JDK-8246774 and JDK-8253455, pushed too soon
  • a0382cd: 8253235: JFR.dump does not respect maxage parameter
  • cb7701b: 8253970: Build error: address argument to atomic builtin must be a pointer to integer or pointer ('volatile narrowOop *' invalid)
  • 4ffed32: 8254940: AArch64: Cleanup non-product thread members
  • cd66e0f: 8253877: gc/g1/TestGCLogMessages.java fails - missing "Evacuation failure" message
  • e76de18: 8223051: support loops with long (64b) trip counts
  • e9be2db: 8253453: SourceFileInfoTable should be allocated lazily
  • e10b538: 8243962: Various JVM TI tests time out using JFR on Windows
  • a1a3e9d: 8254882: ZGC: Use static_assert instead of guarantee
  • ... and 65 more: https://git.openjdk.java.net/jdk/compare/3fb2e822be11a8fdfa708f88b7dcf7a5066a2335...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 label Oct 19, 2020
@jonathan-gibbons
Copy link
Contributor Author

@jonathan-gibbons jonathan-gibbons commented Oct 19, 2020

/integrate

@openjdk openjdk bot closed this Oct 19, 2020
@openjdk openjdk bot added integrated and removed ready rfr labels Oct 19, 2020
@openjdk
Copy link

@openjdk openjdk bot commented Oct 19, 2020

@jonathan-gibbons Since your change was applied there have been 75 commits pushed to the master branch:

  • 953e472: 8254967: com.sun.net.HttpsServer spins on TLS session close
  • 1da28de: 8255009: delta apply fixes for JDK-8246774 and JDK-8253455, pushed too soon
  • a0382cd: 8253235: JFR.dump does not respect maxage parameter
  • cb7701b: 8253970: Build error: address argument to atomic builtin must be a pointer to integer or pointer ('volatile narrowOop *' invalid)
  • 4ffed32: 8254940: AArch64: Cleanup non-product thread members
  • cd66e0f: 8253877: gc/g1/TestGCLogMessages.java fails - missing "Evacuation failure" message
  • e76de18: 8223051: support loops with long (64b) trip counts
  • e9be2db: 8253453: SourceFileInfoTable should be allocated lazily
  • e10b538: 8243962: Various JVM TI tests time out using JFR on Windows
  • a1a3e9d: 8254882: ZGC: Use static_assert instead of guarantee
  • ... and 65 more: https://git.openjdk.java.net/jdk/compare/3fb2e822be11a8fdfa708f88b7dcf7a5066a2335...master

Your commit was automatically rebased without conflicts.

Pushed as commit 60f63ec.

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

@jonathan-gibbons jonathan-gibbons deleted the jonathan-gibbons:8254796-docEnv-parameter branch Nov 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants