8176509: Use pandoc for converting build readme to html

[zzambers]

This backport switches to pandoc for coversion of building readme to html. It also does some style/formating changes/fixes to building readme, which is moved to new location and also removes redundant information in other Readme files.

Backport is not clear. Code for coversion to html had to be modified to work with JDK8 build system. Change set (patch) for building readme mostly applied automatically, but some parts had to be done by hand due to few differences.

Unlike in original change set, this backport moves README-builds.{md,html} files directly to doc/building.{md,html} and not to intermediate location common/doc/building.{md,html}. (additional move was done in jdk10 as part of JDK-8187443)

---

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
• JDK-8176509 needs maintainer approval

Issue

• JDK-8176509: Use pandoc for converting build readme to html (Bug - P3 - Approved)

Reviewers

• Andrew John Hughes (@gnu-andrew - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk8u-dev.git pull/370/head:pull/370
$ git checkout pull/370

Update a local copy of the PR:
$ git checkout pull/370
$ git pull https://git.openjdk.org/jdk8u-dev.git pull/370/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 370

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk8u-dev/pull/370.diff

Webrev

Link to Webrev Comment

[bridgekeeper]

👋 Welcome back zzambers! 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]

This backport pull request has now been updated with issue from the original commit.

[mlbridge]

Webrevs

• 00: Full (1ff35838)

[bridgekeeper]

@zzambers 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!

[bridgekeeper]

@zzambers This pull request has been inactive for more than 8 weeks and will now be automatically closed. If you would like to continue working on this pull request in the future, feel free to reopen it! This can be done using the /open pull request command.

[zzambers]

/open

[openjdk]

@zzambers This pull request is now open

[gnu-andrew]

Looks good to me. 8u build requirements seem to have been retained as is and I think moving the file to the final place here is the right thing to do.

[openjdk]

⚠️ @zzambers This change is now ready for you to apply for maintainer approval. This can be done directly in each associated issue or by using the /approval command.

[zzambers]

/approval request Backport switches to pandoc for builds readme html generation (+ does some docs fixes), GHA tests ok

[openjdk]

@zzambers
8176509: The approval request has been created successfully.

[zzambers]

Looks good to me. 8u build requirements seem to have been retained as is and I think moving the file to the final place here is the right thing to do.

Yy, pandoc should be optional, it builds without it in GHA.

Unfortunately there is little additional noise in generated-configure.sh's diff concerning --runstatedir option, even though, I have used same version of autofonf, as was used before (2.69). It boils down to whether autoconf is ran on distro which has specific backport. (Not present on rhel-8 I used) But I don't think this affects OpenJDK in any way.

[gnu-andrew]

Looks good to me. 8u build requirements seem to have been retained as is and I think moving the file to the final place here is the right thing to do.

Yy, pandoc should be optional, it builds without it in GHA.

Unfortunately there is little additional noise in generated-configure.sh's diff concerning --runstatedir option, even though, I have used same version of autofonf, as was used before (2.69). It boils down to whether autoconf is ran on distro which has specific backport. (Not present on rhel-8 I used) But I don't think this affects OpenJDK in any way.

No, it shouldn't and one can always regenerate configure if it is an issue. I'm in two minds about whether it is finally time to backport JDK-8195689 to 8u and get rid of this once and for all. It is the only JDK to have this baggage (it is removed in 11u and up) and I think it causes more problems than it solves, but then I've never been a fan of bundling generated files to begin with.

[gnu-andrew]

/approve yes

[openjdk]

@gnu-andrew
8176509: The approval request has been approved.

[openjdk]

@zzambers This change now passes all automated pre-integration checks.

After integration, the commit message for the final commit will be:

8176509: Use pandoc for converting build readme to html

Reviewed-by: andrew

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

• 0e7ebcb: 8317291: Missing null check for nmethod::is_native_method()
• eace2d7: 8305329: [8u] Unify test libraries into single test library - step 1
• dd43bdd: 8319405: [s390] [jdk8] Increase javac default stack size for s390x zero
• 8de4819: Merge
• 9499e54: 8317040: Exclude cleaner test failing on older releases
• 47a816e: 8315135: Memory leak in the native implementation of Pack200.Unpacker.unpack()
• dee2d2d: 8286503: Enhance security classes
• 33f3f1c: 8284910: Buffer clean in PasswordCallback
• 32ec85f: 8309966: Enhanced TLS connections
• 9b6da14: 8305815: Update Libpng to 1.6.39
• ... and 28 more: https://git.openjdk.org/jdk8u-dev/compare/89a08b389947078ae150a758c1ff9da7ba404857...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.

[zzambers]

@gnu-andrew thanks
/integrate

[openjdk]

Going to push as commit 10a653e.
Since your change was applied there have been 38 commits pushed to the master branch:

• 0e7ebcb: 8317291: Missing null check for nmethod::is_native_method()
• eace2d7: 8305329: [8u] Unify test libraries into single test library - step 1
• dd43bdd: 8319405: [s390] [jdk8] Increase javac default stack size for s390x zero
• 8de4819: Merge
• 9499e54: 8317040: Exclude cleaner test failing on older releases
• 47a816e: 8315135: Memory leak in the native implementation of Pack200.Unpacker.unpack()
• dee2d2d: 8286503: Enhance security classes
• 33f3f1c: 8284910: Buffer clean in PasswordCallback
• 32ec85f: 8309966: Enhanced TLS connections
• 9b6da14: 8305815: Update Libpng to 1.6.39
• ... and 28 more: https://git.openjdk.org/jdk8u-dev/compare/89a08b389947078ae150a758c1ff9da7ba404857...master

Your commit was automatically rebased without conflicts.

[openjdk]

@zzambers Pushed as commit 10a653e.

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