Skip to content
This repository has been archived by the owner. It is now read-only.

JDK-8258657: Doc build is broken by use of new language features #88

Closed
wants to merge 4 commits into from

Conversation

@erikj79
Copy link
Member

@erikj79 erikj79 commented Jan 5, 2021

This patch changes how the docs-reference make target behaves to better support the requirements for it. This target is used to generate javadocs in a more stable way between releases, so that they those docs are better suited for generating diffs between releases. Currently we use the boot JDK to run javadoc for these, but this has shown to be problematic. This patch introduced a specific configure parameter for the JDK to use just for generating these docs. If not set, it will revert to the default interim javadoc, just like the main docs are built (but still with a separate set of parameters).

This fix needs to go into JDK 16 so that the docs-reference target there can be used to generate diffs for JDK 17.


Progress

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

Issue

  • JDK-8258657: Doc build is broken by use of new language features

Reviewers

Download

$ git fetch https://git.openjdk.java.net/jdk16 pull/88/head:pull/88
$ git checkout pull/88

@bridgekeeper
Copy link

@bridgekeeper bridgekeeper bot commented Jan 5, 2021

👋 Welcome back erikj! 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 Jan 5, 2021
@openjdk
Copy link

@openjdk openjdk bot commented Jan 5, 2021

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

  • build

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 build label Jan 5, 2021
@mlbridge
Copy link

@mlbridge mlbridge bot commented Jan 5, 2021

Webrevs

@openjdk
Copy link

@openjdk openjdk bot commented Jan 6, 2021

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

8258657: Doc build is broken by use of new language features

Reviewed-by: tbell, iris

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

  • 4a478b8: 8250903: jdk/jfr/javaagent/TestLoadedAgent.java fails with Mismatch in TestEvent count
  • 4f914e2: 8249633: doclint reports missing javadoc for JavaFX property methods that have a property description
  • eef43be: 8251200: False positive messages about missing comments for serialization
  • f1bc4e0: 8259312: VerifyCACerts.java fails as soneraclass2ca cert will expire in 90 days
  • 4a5786b: 8259075: Update the copyright notice in the files generated by CLDR Converter tool
  • d25a1be: 8259224: (ann) getAnnotatedReceiverType should not parameterize owner(s) of statically nested classes
  • ad45678: 8258558: Revert changes for JDK-8252505 and related issues
  • e66187d: 8259032: MappedMemorySegmentImpl#makeMappedSegment() ignores Unmapper#pagePosition
  • 80110da: 8259007: This test printed a blank page
  • 554e60c: 8258989: JVM is failed to inline in jdk.internal.vm.vector.VectorSupport::convert
  • ... and 3 more: https://git.openjdk.java.net/jdk16/compare/bbc2e9510bb32d69d823bd572b6c0c02bd2335af...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 Jan 6, 2021
Copy link
Member

@irisclark irisclark left a comment

Do you need to update the copyright year? Other than that, your changes appear to implement the described behaviour.

Thanks!
Iris

@erikj79
Copy link
Member Author

@erikj79 erikj79 commented Jan 7, 2021

/integrate

@openjdk openjdk bot closed this Jan 7, 2021
@openjdk openjdk bot added integrated and removed ready rfr labels Jan 7, 2021
@openjdk
Copy link

@openjdk openjdk bot commented Jan 7, 2021

@erikj79 Since your change was applied there have been 13 commits pushed to the master branch:

  • 4a478b8: 8250903: jdk/jfr/javaagent/TestLoadedAgent.java fails with Mismatch in TestEvent count
  • 4f914e2: 8249633: doclint reports missing javadoc for JavaFX property methods that have a property description
  • eef43be: 8251200: False positive messages about missing comments for serialization
  • f1bc4e0: 8259312: VerifyCACerts.java fails as soneraclass2ca cert will expire in 90 days
  • 4a5786b: 8259075: Update the copyright notice in the files generated by CLDR Converter tool
  • d25a1be: 8259224: (ann) getAnnotatedReceiverType should not parameterize owner(s) of statically nested classes
  • ad45678: 8258558: Revert changes for JDK-8252505 and related issues
  • e66187d: 8259032: MappedMemorySegmentImpl#makeMappedSegment() ignores Unmapper#pagePosition
  • 80110da: 8259007: This test printed a blank page
  • 554e60c: 8258989: JVM is failed to inline in jdk.internal.vm.vector.VectorSupport::convert
  • ... and 3 more: https://git.openjdk.java.net/jdk16/compare/bbc2e9510bb32d69d823bd572b6c0c02bd2335af...master

Your commit was automatically rebased without conflicts.

Pushed as commit 484e23b.

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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
3 participants