archive/node
1
0
Fork 0
mirror of https://github.com/nodejs/node.git synced 2025-08-15 13:48:44 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

doc, build: fixup build docs

Browse source 
PR-URL: https://github.com/nodejs/node/pull/54899
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
This commit is contained in:
Aviv Keller 2024-09-14 07:45:38 -04:00 • committed by GitHub
parent cb20c5b9f4
commit 45f44badaf
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 14 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

25
BUILDING.md
View file

@ -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
<https://www.openssl.org/docs/man1.1.1/man3/OPENSSL_ia32cap.html> for details.
Please refer to <https://docs.openssl.org/1.1.1/man3/OPENSSL_ia32cap/> 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, <https://github.com/microsoft/vcpkg/issues/37518>, [vcpkg](https://github.com/microsoft/vcpkg/)
Refs:
1. <https://github.com/nodejs/node/issues/24448>
2. <https://github.com/microsoft/vcpkg/issues/37518> / <https://github.com/microsoft/vcpkg/discussions/37546>
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
<https://boxstarter.org/package/nr/url?https://raw.githubusercontent.com/nodejs/node/HEAD/tools/bootstrap/windows_boxstarter>
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