doc: note the system requirements for V8 tests

The `test-v8` Makefile target still requires Python 2, and it requires a full Xcode install on macOS. Refs: #36691 PR-URL: #38319 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
nodejs · Jun 5, 2021 · 5a45305 · 5a45305
1 parent 33ddb98
commit 5a45305
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/doc/guides/maintaining-V8.md b/doc/guides/maintaining-V8.md
@@ -229,7 +229,7 @@ to be cherry-picked in the Node.js repository and V8-CI must test the change.
   * Run the Node.js [V8 CI][] in addition to the [Node.js CI][].
     The CI uses the `test-v8` target in the `Makefile`, which uses
     `tools/make-v8.sh` to reconstruct a git tree in the `deps/v8` directory to
-    run V8 tests.
+    run V8 tests<sup>2</sup>.
 
 The [`git-node`][] tool can be used to simplify this task. Run
 `git node v8 backport <sha>` to cherry-pick a commit.
@@ -414,6 +414,11 @@ This would require some tooling to:
 <sup>1</sup>Node.js 0.12 and older are intentionally omitted from this document
 as their support has ended.
 
+<sup>2</sup>The V8 tests still require Python 2. To run these tests locally,
+you can run `PYTHON2 ./configure.py` before running `make test-v8`, in the root
+of this repository. On macOS, this also requires a full Xcode install,
+not just the "command line tools" for Xcode.
+
 [ChromiumReleaseCalendar]: https://www.chromium.org/developers/calendar
 [Node.js CI]: https://ci.nodejs.org/job/node-test-pull-request/
 [Node.js `canary` branch]: https://github.com/nodejs/node-v8/tree/canary