From 4a6b92216de890616d39b8df688e29c8520d62b6 Mon Sep 17 00:00:00 2001 From: Aviv Keller Date: Thu, 12 Sep 2024 07:39:15 -0400 Subject: [PATCH 1/2] doc, build: fixup build docs --- BUILDING.md | 47 +++++++++++++++++++++++++---------------------- 1 file changed, 25 insertions(+), 22 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index d702bd09481ddf..635624c184d022 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -158,17 +158,17 @@ Depending on the host platform, the selection of toolchains may vary. Binaries at are produced on: -| Binary package | Platform and Toolchain | -| ----------------------- | ----------------------------------------------------------------------------------------------------------- | -| aix-ppc64 | AIX 7.2 TL04 on PPC64BE with GCC 12[^5] | -| darwin-x64 | macOS 11, Xcode 13 with -mmacosx-version-min=11.0 | -| darwin-arm64 (and .pkg) | macOS 11 (arm64), Xcode 13 with -mmacosx-version-min=11.0 | -| linux-arm64 | RHEL 8 with GCC 10[^6] | -| linux-armv7l | Cross-compiled on RHEL 8 x64 with [custom GCC toolchain](https://github.com/rvagg/rpi-newer-crosstools)[^7] | -| linux-ppc64le | RHEL 8 with gcc-toolset-10[^6] | -| linux-s390x | RHEL 8 with gcc-toolset-10[^6] | -| linux-x64 | RHEL 8 with gcc-toolset-10[^6] | -| win-x64 | Windows Server 2022 (x64) with Visual Studio 2022 | +| Binary package | Platform and Toolchain | +| ----------------------- | ------------------------------------------------------------------------------------------------------------- | +| aix-ppc64 | AIX 7.2 TL04 on PPC64BE with GCC 12[^5] | +| darwin-x64 | macOS 11, Xcode 13 with -mmacosx-version-min=11.0 | +| darwin-arm64 (and .pkg) | macOS 11 (arm64), Xcode 13 with -mmacosx-version-min=11.0 | +| linux-arm64 | RHEL 8 with GCC 10[^6] | +| linux-armv7l | Cross-compiled on RHEL 8 x64 with a [custom GCC toolchain](https://github.com/rvagg/rpi-newer-crosstools)[^7] | +| linux-ppc64le | RHEL 8 with gcc-toolset-10[^6] | +| linux-s390x | RHEL 8 with gcc-toolset-10[^6] | +| linux-x64 | RHEL 8 with gcc-toolset-10[^6] | +| win-x64 | Windows Server 2022 (x64) with Visual Studio 2022 | @@ -206,8 +206,7 @@ For use of AVX2, * llvm version 3.3 or higher * nasm version 2.10 or higher in Windows -Please refer to - for details. +Please refer to for details. If compiling without one of the above, use `configure` with the `--openssl-no-asm` flag. Otherwise, `configure` will fail. @@ -525,7 +524,7 @@ $ gdb /opt/node-debug/node core.node.8.1535359906 [ASan](https://github.com/google/sanitizers) can help detect various memory related bugs. ASan builds are currently only supported on linux. If you want to check it on Windows or macOS or you want a consistent toolchain -on Linux, you can try [Docker](https://www.docker.com/products/docker-desktop) +on Linux, you can try [Docker](https://www.docker.com/products/docker-desktop/) (using an image like `gengjiawen/node-build:2020-02-14`). The `--debug` is not necessary and will slow down build and testing, but it can @@ -618,7 +617,11 @@ vcpkg owns zlib1.dll vcpkg integrate remove ``` -Refs: #24448, , [vcpkg](https://github.com/microsoft/vcpkg/) +Refs: + +1. +2. / +3. [vcpkg](https://github.com/microsoft/vcpkg/) #### Windows Prerequisites @@ -677,9 +680,9 @@ packages: * [NetWide Assembler](https://chocolatey.org/packages/nasm) To install Node.js prerequisites using -[Boxstarter WebLauncher](https://boxstarter.org/weblauncher), open +[Boxstarter WebLauncher](https://boxstarter.org/weblauncher), visit -with Edge browser on the target machine. +with a supported browser. Alternatively, you can use PowerShell. Run those commands from an elevated (Administrator) PowerShell terminal: @@ -754,7 +757,7 @@ architecture supports \[arm, arm64/aarch64, x86, x86\_64]. ## `Intl` (ECMA-402) support -[Intl](https://github.com/nodejs/node/blob/HEAD/doc/api/intl.md) support is +[Intl](doc/api/intl.md) support is enabled by default. ### Build with full ICU support (all locales supported by ICU) @@ -820,7 +823,7 @@ that works for both your host and target environments. ### Build with a specific ICU You can find other ICU releases at -[the ICU homepage](http://site.icu-project.org/download). +[the ICU homepage](https://icu.unicode.org/download). Download the file named something like `icu4c-**##.#**-src.tgz` (or `.zip`). @@ -851,7 +854,7 @@ From a tarball URL: #### Windows First unpack latest ICU to `deps/icu` -[icu4c-**##.#**-src.tgz](http://site.icu-project.org/download) (or `.zip`) +[icu4c-**##.#**-src.tgz](https://icu.unicode.org/download) (or `.zip`) as `deps/icu` (You'll have: `deps/icu/source/...`) ```powershell @@ -874,10 +877,10 @@ configure option: ## Building Node.js with FIPS-compliant OpenSSL Node.js supports FIPS when statically or dynamically linked with OpenSSL 3 via -[OpenSSL's provider model](https://www.openssl.org/docs/man3.0/man7/crypto.html#OPENSSL-PROVIDERS). +[OpenSSL's provider model](https://docs.openssl.org/3.0/man7/crypto/#OPENSSL-PROVIDERS). It is not necessary to rebuild Node.js to enable support for FIPS. -See [FIPS mode](./doc/api/crypto.md#fips-mode) for more information on how to +See [FIPS mode](doc/api/crypto.md#fips-mode) for more information on how to enable FIPS support in Node.js. ## Building Node.js with external core modules From 1637fba6b7f34d536bf24f14b66629b6596b3caf Mon Sep 17 00:00:00 2001 From: Aviv Keller Date: Thu, 12 Sep 2024 15:31:07 -0400 Subject: [PATCH 2/2] revert --- BUILDING.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index 635624c184d022..46142a3457a49b 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -158,17 +158,17 @@ Depending on the host platform, the selection of toolchains may vary. Binaries at are produced on: -| Binary package | Platform and Toolchain | -| ----------------------- | ------------------------------------------------------------------------------------------------------------- | -| aix-ppc64 | AIX 7.2 TL04 on PPC64BE with GCC 12[^5] | -| darwin-x64 | macOS 11, Xcode 13 with -mmacosx-version-min=11.0 | -| darwin-arm64 (and .pkg) | macOS 11 (arm64), Xcode 13 with -mmacosx-version-min=11.0 | -| linux-arm64 | RHEL 8 with GCC 10[^6] | -| linux-armv7l | Cross-compiled on RHEL 8 x64 with a [custom GCC toolchain](https://github.com/rvagg/rpi-newer-crosstools)[^7] | -| linux-ppc64le | RHEL 8 with gcc-toolset-10[^6] | -| linux-s390x | RHEL 8 with gcc-toolset-10[^6] | -| linux-x64 | RHEL 8 with gcc-toolset-10[^6] | -| win-x64 | Windows Server 2022 (x64) with Visual Studio 2022 | +| Binary package | Platform and Toolchain | +| ----------------------- | ----------------------------------------------------------------------------------------------------------- | +| aix-ppc64 | AIX 7.2 TL04 on PPC64BE with GCC 12[^5] | +| darwin-x64 | macOS 11, Xcode 13 with -mmacosx-version-min=11.0 | +| darwin-arm64 (and .pkg) | macOS 11 (arm64), Xcode 13 with -mmacosx-version-min=11.0 | +| linux-arm64 | RHEL 8 with GCC 10[^6] | +| linux-armv7l | Cross-compiled on RHEL 8 x64 with [custom GCC toolchain](https://github.com/rvagg/rpi-newer-crosstools)[^7] | +| linux-ppc64le | RHEL 8 with gcc-toolset-10[^6] | +| linux-s390x | RHEL 8 with gcc-toolset-10[^6] | +| linux-x64 | RHEL 8 with gcc-toolset-10[^6] | +| win-x64 | Windows Server 2022 (x64) with Visual Studio 2022 |