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

8206311: Add docs-javase, docs-reference to CI build #99

Closed
wants to merge 2 commits into from

Conversation

@erikj79
Copy link
Member

@erikj79 erikj79 commented Sep 9, 2020

Reposting this review as PR.

In order to regularly build the javase and reference docs images, I have made the following changes:

  1. Introduced bundle targets for the javase and reference docs images.
  2. To run this in CI without adding more unnecessary build time to the linux-x64 target (where the current docs are built), I created a new jib profile "docs". This will run in a separate task and will build all 3 docs targets.
  3. To enable the docs targets to run standalone without having to build a full JDK, I had to tweak the "build-jdk" concept a bit, to allow it to also function when not cross compiling for certain parts of the build. Specifically the buildtools-modules can now be built by a "build-jdk" instead of the exploded image.
  4. For symmetry, I renamed variables and targets involving docs images to always include one of "jdk", "javase" or "reference" in the name. See below for targets.

The new top level targets are:

docs-{jdk.javase,reference}-image:
Aliases for the existing docs-{jdk,javase,reference} added for consistency. The old docs-image is now an alias for docs-jdk-image.

all-docs-images:
Builds all 3 of the above docs images.

docs-{jdk,javase,reference}-bundles:
Builds the bundles for each kind of docs image. The existing docs-bundles is now an alias for docs-jdk-bundles.

all-docs-bundles:
Builds all the docs bundles.


Progress

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

Issue

  • JDK-8206311: Add docs-javase, docs-reference to CI build

Reviewers

Download

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

@bridgekeeper
Copy link

@bridgekeeper bridgekeeper bot commented Sep 9, 2020

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

Loading

@openjdk openjdk bot added the rfr label Sep 9, 2020
@openjdk
Copy link

@openjdk openjdk bot commented Sep 9, 2020

@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 (add|remove) "label" command.

Loading

@openjdk openjdk bot added the build label Sep 9, 2020
@mlbridge
Copy link

@mlbridge mlbridge bot commented Sep 9, 2020

Webrevs

Loading

@bridgekeeper
Copy link

@bridgekeeper bridgekeeper bot commented Oct 8, 2020

@erikj79 This pull request has been inactive for more than 4 weeks and will be automatically closed if another 4 weeks passes without any activity. To avoid this, simply add a new comment to the pull request. Feel free to ask for assistance if you need help with progressing this pull request towards integration!

Loading

Copy link
Member

@magicus magicus left a comment

Looks good to me, but I'd like som clarification about the docs jib target.

Loading

configure_args: [
"--enable-full-docs",
"--with-build-jdk=" + input.get(buildJdkDep, "home_path")
+ (input.build_os == "macosx" ? "/Contents/Home" : "")
Copy link
Member

@magicus magicus Oct 19, 2020

Choose a reason for hiding this comment

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

I'm not fully understanding the platform selection mechanism here. Previously, docs were only built on linux-x64. I can see no such filtering in the new code; and this piece here even indicates assumed support for macosx.

Question: Is docs still built only on one platform? How is this achieved then?

Loading

Copy link
Member Author

@erikj79 erikj79 Oct 19, 2020

Choose a reason for hiding this comment

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

I wanted to make the jib profile "docs" buildable on any platform (though I guess windows is likely not going to work well). This makes future development more flexible for local builds. The platform we choose to use for our official CI/tier configurations is controlled elsewhere and will continue to be linux-x64.

Loading

@openjdk
Copy link

@openjdk openjdk bot commented Oct 19, 2020

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

8206311: Add docs-javase, docs-reference to CI build

Reviewed-by: ihse

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

  • 3445031: 8255200: ProblemList com/sun/jdi/EATests.java for ZGC
  • 85a8949: 8254913: Increase InlineSmallCode default from 2000 to 2500 for x64
  • 56ea490: 8233343: Deprecate -XX:+CriticalJNINatives flag which implements JavaCritical native functions
  • 615b759: 8255070: Shenandoah: Use single thread for concurrent CLD liveness test
  • 6020991: 8255068: [JVMCI] errors during compiler creation can be hidden
  • 8d9e6d0: 8255041: Zero: remove old JSR 292 support leftovers
  • 0efdde1: 8238669: Long.divideUnsigned is extremely slow for certain values (Needs to be Intrinsic)
  • 365f19c: 8254790: SIGSEGV in string_indexof_char and stringL_indexof_char intrinsics

Please see this link for an up-to-date comparison between the source branch of this pull request and the master branch.
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.

Loading

@openjdk openjdk bot added the ready label Oct 19, 2020
@erikj79
Copy link
Member Author

@erikj79 erikj79 commented Oct 21, 2020

/integrate

Loading

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

@openjdk openjdk bot commented Oct 21, 2020

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

  • 3445031: 8255200: ProblemList com/sun/jdi/EATests.java for ZGC
  • 85a8949: 8254913: Increase InlineSmallCode default from 2000 to 2500 for x64
  • 56ea490: 8233343: Deprecate -XX:+CriticalJNINatives flag which implements JavaCritical native functions
  • 615b759: 8255070: Shenandoah: Use single thread for concurrent CLD liveness test
  • 6020991: 8255068: [JVMCI] errors during compiler creation can be hidden
  • 8d9e6d0: 8255041: Zero: remove old JSR 292 support leftovers
  • 0efdde1: 8238669: Long.divideUnsigned is extremely slow for certain values (Needs to be Intrinsic)
  • 365f19c: 8254790: SIGSEGV in string_indexof_char and stringL_indexof_char intrinsics

Your commit was automatically rebased without conflicts.

Pushed as commit 9ade94b.

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

Loading

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants