From 9311749edca0a8afdd2d15fb059be08389a5a1de Mon Sep 17 00:00:00 2001 From: Magnus Ihse Bursie Date: Tue, 21 Nov 2023 16:27:15 +0000 Subject: [PATCH] 8320526: Use title case in building.md Reviewed-by: iris --- doc/building.html | 40 ++++++++++++++++++++-------------------- doc/building.md | 18 +++++++++--------- 2 files changed, 29 insertions(+), 29 deletions(-) diff --git a/doc/building.html b/doc/building.html index 09251053fc0..3aad6eae074 100644 --- a/doc/building.html +++ b/doc/building.html @@ -49,7 +49,7 @@ x86
  • Building on aarch64
  • Building on 32-bit arm
    • +id="toc-building-on-32-bit-arm">Building on 32-bit ARM
  • Operating System Requirements @@ -74,7 +74,7 @@ id="toc-microsoft-visual-studio">Microsoft Visual Studio
    • JDK Requirements
  • External Library Requirements @@ -116,7 +116,7 @@ Tests
  • macOS
  • Cross-compiling +id="toc-cross-compiling">Cross-Compiling
  • Build Performance @@ -146,9 +146,9 @@ Checking
  • Precompiled Headers
  • Icecc / -icecream
    • +Icecream
  • Using the javac server
    • +id="toc-using-the-javac-server">Using the javac Server
  • Building the Right Target
    • @@ -202,7 +202,7 @@ Itself
  • Contributing to the JDK
  • Editing this document
    • +id="toc-editing-this-document">Editing This Document

    TL;DR (Instructions for the @@ -341,7 +341,7 @@ requires C++ compiler support (GCC 9.1.0+ or Clang 10+). The resulting build can be run on both machines with and without support for branch protection in hardware. Branch Protection is only supported for Linux targets.

    -

    Building on 32-bit arm

    +

    Building on 32-bit ARM

    This is not recommended. Instead, see the section on Cross-compiling.

    Operating System @@ -698,7 +698,7 @@ JDK automatically, but due to the lack of standard installation locations on most platforms, this heuristics has a high likelihood to fail. If the boot JDK is not automatically detected, or the wrong JDK is picked, use --with-boot-jdk to point to the JDK to use.

    -

    Getting JDK binaries

    +

    Getting JDK Binaries

    An overview of common ways to download and install prebuilt JDK binaries can be found on https://openjdk.org/install. An alternative is to download the release and either the default identity or the specified identity is valid. If hardened isn't possible, then debug signing is chosen if it works. If nothing works, the codesign build step is disabled.

    -

    Cross-compiling

    +

    Cross-Compiling

    Cross-compiling means using one platform (the build platform) to generate output that can ran on another platform (the target platform).

    @@ -1399,7 +1399,7 @@ cp: cannot stat `arm-linux-gnueabihf/libXt.so': No such file or directorytarget system.

    Copy these folders to your target system. Then you can run e.g. images/jdk/bin/java -version.

    -

    Cross compiling the easy way

    +

    Cross-Compiling the Easy Way

    Setting up a proper cross-compilation environment can be a lot of work. Fortunately there are ways that more or less automate this process. Here are two recommended methods, using the "devkits" that can @@ -1409,7 +1409,7 @@ Linux distributions, the latter only on Debian and derivatives. Both solution only work for gcc.

    The devkit method is regularly used for testing by Oracle, and the debootstrap method is regularly used in GitHub Actions testing.

    -

    Using OpenJDK devkits

    +

    Using OpenJDK Devkits

    The JDK build system provides out-of-the box support for creating and using so called devkits. A devkit is basically a collection of a cross-compiling toolchain and a sysroot environment which can @@ -1660,8 +1660,8 @@ are:

    -

    Considerations for specific -targets

    +

    Considerations for Specific +Targets

    Building for ARM32

    A common cross-compilation target is the ARM CPU. When building for ARM, it is recommended to set the ABI profile. A number of pre-defined @@ -1772,7 +1772,7 @@ Studio). Normally, this speeds up the build process, but in some circumstances, it can actually slow things down.

    You can experiment by disabling pre-compiled headers using --disable-precompiled-headers.

    -

    Icecc / icecream

    +

    Icecc / Icecream

    icecc/icecream is a simple way to setup a distributed compiler network. If you have multiple machines available for building the JDK, you can drastically cut @@ -1780,7 +1780,7 @@ individual build times by utilizing it.

    To use, setup an icecc network, and install icecc on the build machine. Then run configure using --enable-icecc.

    -

    Using the javac server

    +

    Using the javac Server

    To speed up compilation of Java code, especially during incremental compilations, the javac server is automatically enabled in the configuration step by default. To explicitly enable or disable the javac @@ -2456,7 +2456,7 @@ must ask you to follow our rules and guidelines to be able to accept your contribution.

    The official place to start is the OpenJDK Developers’ Guide.

    -

    Editing this document

    +

    Editing This Document

    If you want to contribute changes to this document, edit doc/building.md and then run make update-build-docs to generate the same changes in diff --git a/doc/building.md b/doc/building.md index e3397641374..611cfe15915 100644 --- a/doc/building.md +++ b/doc/building.md @@ -154,7 +154,7 @@ support (GCC 9.1.0+ or Clang 10+). The resulting build can be run on both machines with and without support for branch protection in hardware. Branch Protection is only supported for Linux targets. -### Building on 32-bit arm +### Building on 32-bit ARM This is not recommended. Instead, see the section on [Cross-compiling]( #cross-compiling). @@ -518,7 +518,7 @@ heuristics has a high likelihood to fail. If the boot JDK is not automatically detected, or the wrong JDK is picked, use `--with-boot-jdk` to point to the JDK to use. -### Getting JDK binaries +### Getting JDK Binaries An overview of common ways to download and install prebuilt JDK binaries can be found on https://openjdk.org/install. An alternative is to download the [Oracle @@ -1026,7 +1026,7 @@ The default mode "auto" will try for `hardened` signing if the debug level is If hardened isn't possible, then `debug` signing is chosen if it works. If nothing works, the codesign build step is disabled. -## Cross-compiling +## Cross-Compiling Cross-compiling means using one platform (the *build* platform) to generate output that can ran on another platform (the *target* platform). @@ -1213,7 +1213,7 @@ built JDK, for your *target* system. Copy these folders to your *target* system. Then you can run e.g. `images/jdk/bin/java -version`. -### Cross compiling the easy way +### Cross-Compiling the Easy Way Setting up a proper cross-compilation environment can be a lot of work. Fortunately there are ways that more or less automate this process. Here are @@ -1225,7 +1225,7 @@ solution only work for gcc. The devkit method is regularly used for testing by Oracle, and the debootstrap method is regularly used in GitHub Actions testing. -#### Using OpenJDK devkits +#### Using OpenJDK Devkits The JDK build system provides out-of-the box support for creating and using so called devkits. A `devkit` is basically a collection of a cross-compiling @@ -1388,7 +1388,7 @@ Architectures that are known to successfully cross-compile like this are: | sh4 | sid | sh4 | sh4-linux-gnu | zero | | riscv64 | sid | riscv64 | riscv64-linux-gnu | (all) | -### Considerations for specific targets +### Considerations for Specific Targets #### Building for ARM32 @@ -1526,7 +1526,7 @@ things down. You can experiment by disabling pre-compiled headers using `--disable-precompiled-headers`. -### Icecc / icecream +### Icecc / Icecream [icecc/icecream](https://github.com/icecc/icecream) is a simple way to setup a distributed compiler network. If you have multiple machines available for @@ -1536,7 +1536,7 @@ it. To use, setup an icecc network, and install icecc on the build machine. Then run `configure` using `--enable-icecc`. -### Using the javac server +### Using the javac Server To speed up compilation of Java code, especially during incremental compilations, the javac server is automatically enabled in the configuration @@ -2274,7 +2274,7 @@ our rules and guidelines to be able to accept your contribution. The official place to start is the [OpenJDK Developers’ Guide]( https://openjdk.org/guide/). -## Editing this document +## Editing This Document If you want to contribute changes to this document, edit `doc/building.md` and then run `make update-build-docs` to generate the same changes in