Skip to content

Commit 4a6b922

Browse files
committed
doc, build: fixup build docs
1 parent 6cc4d5f commit 4a6b922

File tree

1 file changed

+25
-22
lines changed

1 file changed

+25
-22
lines changed

BUILDING.md

Lines changed: 25 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -158,17 +158,17 @@ Depending on the host platform, the selection of toolchains may vary.
158158

159159
Binaries at <https://nodejs.org/download/release/> are produced on:
160160

161-
| Binary package | Platform and Toolchain |
162-
| ----------------------- | ----------------------------------------------------------------------------------------------------------- |
163-
| aix-ppc64 | AIX 7.2 TL04 on PPC64BE with GCC 12[^5] |
164-
| darwin-x64 | macOS 11, Xcode 13 with -mmacosx-version-min=11.0 |
165-
| darwin-arm64 (and .pkg) | macOS 11 (arm64), Xcode 13 with -mmacosx-version-min=11.0 |
166-
| linux-arm64 | RHEL 8 with GCC 10[^6] |
167-
| linux-armv7l | Cross-compiled on RHEL 8 x64 with [custom GCC toolchain](https://github.com/rvagg/rpi-newer-crosstools)[^7] |
168-
| linux-ppc64le | RHEL 8 with gcc-toolset-10[^6] |
169-
| linux-s390x | RHEL 8 with gcc-toolset-10[^6] |
170-
| linux-x64 | RHEL 8 with gcc-toolset-10[^6] |
171-
| win-x64 | Windows Server 2022 (x64) with Visual Studio 2022 |
161+
| Binary package | Platform and Toolchain |
162+
| ----------------------- | ------------------------------------------------------------------------------------------------------------- |
163+
| aix-ppc64 | AIX 7.2 TL04 on PPC64BE with GCC 12[^5] |
164+
| darwin-x64 | macOS 11, Xcode 13 with -mmacosx-version-min=11.0 |
165+
| darwin-arm64 (and .pkg) | macOS 11 (arm64), Xcode 13 with -mmacosx-version-min=11.0 |
166+
| linux-arm64 | RHEL 8 with GCC 10[^6] |
167+
| linux-armv7l | Cross-compiled on RHEL 8 x64 with a [custom GCC toolchain](https://github.com/rvagg/rpi-newer-crosstools)[^7] |
168+
| linux-ppc64le | RHEL 8 with gcc-toolset-10[^6] |
169+
| linux-s390x | RHEL 8 with gcc-toolset-10[^6] |
170+
| linux-x64 | RHEL 8 with gcc-toolset-10[^6] |
171+
| win-x64 | Windows Server 2022 (x64) with Visual Studio 2022 |
172172

173173
<!--lint disable final-definition-->
174174

@@ -206,8 +206,7 @@ For use of AVX2,
206206
* llvm version 3.3 or higher
207207
* nasm version 2.10 or higher in Windows
208208

209-
Please refer to
210-
<https://www.openssl.org/docs/man1.1.1/man3/OPENSSL_ia32cap.html> for details.
209+
Please refer to <https://docs.openssl.org/1.1.1/man3/OPENSSL_ia32cap/> for details.
211210

212211
If compiling without one of the above, use `configure` with the
213212
`--openssl-no-asm` flag. Otherwise, `configure` will fail.
@@ -525,7 +524,7 @@ $ gdb /opt/node-debug/node core.node.8.1535359906
525524
[ASan](https://github.com/google/sanitizers) can help detect various memory
526525
related bugs. ASan builds are currently only supported on linux.
527526
If you want to check it on Windows or macOS or you want a consistent toolchain
528-
on Linux, you can try [Docker](https://www.docker.com/products/docker-desktop)
527+
on Linux, you can try [Docker](https://www.docker.com/products/docker-desktop/)
529528
(using an image like `gengjiawen/node-build:2020-02-14`).
530529

531530
The `--debug` is not necessary and will slow down build and testing, but it can
@@ -618,7 +617,11 @@ vcpkg owns zlib1.dll
618617
vcpkg integrate remove
619618
```
620619

621-
Refs: #24448, <https://github.com/microsoft/vcpkg/issues/37518>, [vcpkg](https://github.com/microsoft/vcpkg/)
620+
Refs:
621+
622+
1. <https://github.com/nodejs/node/issues/24448>
623+
2. <https://github.com/microsoft/vcpkg/issues/37518> / <https://github.com/microsoft/vcpkg/discussions/37546>
624+
3. [vcpkg](https://github.com/microsoft/vcpkg/)
622625

623626
#### Windows Prerequisites
624627

@@ -677,9 +680,9 @@ packages:
677680
* [NetWide Assembler](https://chocolatey.org/packages/nasm)
678681

679682
To install Node.js prerequisites using
680-
[Boxstarter WebLauncher](https://boxstarter.org/weblauncher), open
683+
[Boxstarter WebLauncher](https://boxstarter.org/weblauncher), visit
681684
<https://boxstarter.org/package/nr/url?https://raw.githubusercontent.com/nodejs/node/HEAD/tools/bootstrap/windows_boxstarter>
682-
with Edge browser on the target machine.
685+
with a supported browser.
683686

684687
Alternatively, you can use PowerShell. Run those commands from
685688
an elevated (Administrator) PowerShell terminal:
@@ -754,7 +757,7 @@ architecture supports \[arm, arm64/aarch64, x86, x86\_64].
754757

755758
## `Intl` (ECMA-402) support
756759

757-
[Intl](https://github.com/nodejs/node/blob/HEAD/doc/api/intl.md) support is
760+
[Intl](doc/api/intl.md) support is
758761
enabled by default.
759762

760763
### Build with full ICU support (all locales supported by ICU)
@@ -820,7 +823,7 @@ that works for both your host and target environments.
820823
### Build with a specific ICU
821824

822825
You can find other ICU releases at
823-
[the ICU homepage](http://site.icu-project.org/download).
826+
[the ICU homepage](https://icu.unicode.org/download).
824827
Download the file named something like `icu4c-**##.#**-src.tgz` (or
825828
`.zip`).
826829

@@ -851,7 +854,7 @@ From a tarball URL:
851854
#### Windows
852855

853856
First unpack latest ICU to `deps/icu`
854-
[icu4c-**##.#**-src.tgz](http://site.icu-project.org/download) (or `.zip`)
857+
[icu4c-**##.#**-src.tgz](https://icu.unicode.org/download) (or `.zip`)
855858
as `deps/icu` (You'll have: `deps/icu/source/...`)
856859

857860
```powershell
@@ -874,10 +877,10 @@ configure option:
874877
## Building Node.js with FIPS-compliant OpenSSL
875878

876879
Node.js supports FIPS when statically or dynamically linked with OpenSSL 3 via
877-
[OpenSSL's provider model](https://www.openssl.org/docs/man3.0/man7/crypto.html#OPENSSL-PROVIDERS).
880+
[OpenSSL's provider model](https://docs.openssl.org/3.0/man7/crypto/#OPENSSL-PROVIDERS).
878881
It is not necessary to rebuild Node.js to enable support for FIPS.
879882

880-
See [FIPS mode](./doc/api/crypto.md#fips-mode) for more information on how to
883+
See [FIPS mode](doc/api/crypto.md#fips-mode) for more information on how to
881884
enable FIPS support in Node.js.
882885

883886
## Building Node.js with external core modules

0 commit comments

Comments
 (0)