8320258: Refresh building.md

[magicus]

The contents of the build README has been poorly kept up to date in places. With the move to Github, the need to have markdown syntax that looks good on Github has become apparent. The entire document has been in need for a while of a comprehensive oversight to be made more consistent in language and formatting.

Here is a summary of the most important changes:

• The entire section on cross-compiling have been restructured to be more logical, and some parts have been rewritten, so it reads more coherent.
• A section on "make doctor" has been added
• The fixpath.sh script has been explained more in detail (and references to the old fixpath binary removed)
• Information about MSYS2 and WSL has been updated
• References to how things were done in the past, like the hg forest have been removed
• Version numbers have been updated where needed
• Some specific paragraphs about e.g. boot JDK detection have been clarified
• Example output have been updated
• Remaining references to run-test have been updated to just test
• Internal links have been fixed in a few places
• A few remaining places that confuses "OpenJDK" with the "JDK" have been fixed
• Markdown formatting has been improved in some places
• The entire file has gotten more normalized markdown formatting (fix bullet list indentation, add empty lines surrounding the code block markers, etc)

Note that this PR will can possibly create a merge conflict with 8317357 and 8264425; my intention is to integrate these two first and then resolve any conflicts in this PR.

---

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

Issue

• JDK-8320258: Refresh building.md (Bug - P3)

Reviewers

• Erik Joelsson (@erikj79 - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/16696/head:pull/16696
$ git checkout pull/16696

Update a local copy of the PR:
$ git checkout pull/16696
$ git pull https://git.openjdk.org/jdk.git pull/16696/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 16696

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/16696.diff

Webrev

Link to Webrev Comment

[bridgekeeper]

👋 Welcome back ihse! 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.

[magicus]

The resulting markdown file can be seen here: https://github.com/magicus/jdk/blob/readme-refresh/doc/building.md
The resulting HTML can be seen here: https://htmlpreview.github.io/?https://github.com/magicus/jdk/blob/readme-refresh/doc/building.html

[openjdk]

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

[mlbridge]

Webrevs

• 04: Full - Incremental (cc520ddf)
• 03: Full - Incremental (92b0c7e4)
• 02: Full - Incremental (738df1af)
• 01: Full (f3b3a882)
• 00: Full (d37e5a77)

[erikj79]

Thank you for taking on the complete file, this looks much better. Just a few comments.

[magicus]

I have now checked the grammar of the entire document with automated tools. :) I pushed some of the suggested changes.

[erikj79]

Looks good! I like the automated grammar/spelling corrections.

[openjdk]

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

8320258: Refresh building.md

Reviewed-by: erikj

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

• b5a7562: 8319985: Delete sun.awt.windows.WToolkit.embedded*() API
• 1fce70b: 8320334: Reflow markdown in testing.md

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.

[magicus]

/integrate

[openjdk]

Going to push as commit 99570fb.
Since your change was applied there have been 5 commits pushed to the master branch:

• a1e7a30: 8320212: Disable GCC stringop-overflow warning for affected files
• 0881f2b: 8318562: Computational test more than 2x slower when AVX instructions are used
• 9b372e2: 8320206: Some intrinsics/stubs missing vzeroupper on x86_64
• b5a7562: 8319985: Delete sun.awt.windows.WToolkit.embedded*() API
• 1fce70b: 8320334: Reflow markdown in testing.md

Your commit was automatically rebased without conflicts.

[openjdk]

@magicus Pushed as commit 99570fb.

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