Skip to content

Commit 05a7b0a

Browse files
MikeMcC399aduh95
authored andcommitted
doc: add Rust toolchain general install instructions
Signed-off-by: Mike McCready <66998419+MikeMcC399@users.noreply.github.com> PR-URL: #63426 Refs: #63225 Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: Richard Lau <richard.lau@ibm.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
1 parent 1a4090a commit 05a7b0a

1 file changed

Lines changed: 16 additions & 1 deletion

File tree

BUILDING.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,10 +237,23 @@ tarball and/or browse the git repository checked out at the relevant tag.
237237
### Prerequisites
238238

239239
* [A supported version of Python][Python versions] for building and testing.
240-
* Memory: at least 8GB of RAM is typically required when compiling with 4 parallel jobs (e.g: `make -j4`)
240+
* A Rust toolchain if [building Node.js with Temporal support](#building-nodejs-with-temporal-support)
241+
is required (enabled by default starting in Node.js 26).
242+
* Memory: at least 8GB of RAM is typically required when compiling with 4 parallel jobs (e.g: `make -j4`).
241243

242244
### Unix and macOS
243245

246+
Consult the official [Install Rust](https://rust-lang.org/tools/install/)
247+
instructions to install a Rust toolchain, required for Temporal support introduced in Node.js 25.4.0.
248+
Individual packages such as `rust` and `cargo` in some operating system distributions may be considered
249+
as an alternative, for example in CI environments.
250+
Consult with relevant operating system documentation to ensure that packages
251+
meet the minimum version specified in the
252+
[Building Node.js with Temporal support](#building-nodejs-with-temporal-support) section,
253+
as packaged versions may lag behind the `stable` version installed by the official instructions.
254+
Avoid mixing `rustup` together with `rust` and `cargo` package installations, due to
255+
potential version conflicts.
256+
244257
#### Unix prerequisites
245258

246259
* `gcc` and `g++` >= 13.2 or `clang` and `clang++` >= 19.1
@@ -1056,6 +1069,8 @@ requires a Rust toolchain:
10561069
* rustc >= 1.82 (with LLVM >= 19)
10571070
* cargo >= 1.82
10581071

1072+
Refer to [Install Rust](https://rust-lang.org/tools/install/) for instructions.
1073+
10591074
If `--v8-enable-temporal-support` and `--v8-disable-temporal-support` are both
10601075
omitted, `configure.py` probes for `cargo` and `rustc`. If either is missing,
10611076
a warning is printed and Temporal support is disabled.

0 commit comments

Comments
 (0)