From 9b4cb9d43f31d6a84493aff1c30ce7de618c3f03 Mon Sep 17 00:00:00 2001 From: Immanuel Haffner Date: Sat, 4 May 2024 20:20:03 +0200 Subject: [PATCH] [Doc] Update V8-related documentation. Mark the manual setup of depot_tools and gn as deprecated. --- doc/setup-building-with-V8.md | 9 ++++++++- doc/setup-depot_tools.md | 7 +++++++ doc/setup-gn.md | 7 +++++++ doc/setup.md | 5 ++++- 4 files changed, 26 insertions(+), 2 deletions(-) diff --git a/doc/setup-building-with-V8.md b/doc/setup-building-with-V8.md index 2f71e93e..083af000 100644 --- a/doc/setup-building-with-V8.md +++ b/doc/setup-building-with-V8.md @@ -1,12 +1,19 @@ # Building mu*t*able with V8 +🚨🚨🚨 **DEPRECATED** 🚨🚨🚨 + +We ship our dependencies during CMake configure. +No manual setup is required. + ## Dependencies -Install the following dependencies: +~~Install the following dependencies:~~ * [Google `depot_tools`](setup-depot_tools.md) * [Google `gn`](setup-gn.md) +V8 requires the Google depot_tools, that we ship during CMake configure. + ## Configuration #### Disable `depot_tools` Self-Updates diff --git a/doc/setup-depot_tools.md b/doc/setup-depot_tools.md index 28fd20a3..e02c6fe2 100644 --- a/doc/setup-depot_tools.md +++ b/doc/setup-depot_tools.md @@ -1,5 +1,12 @@ # Install Google `depot_tools` +🚨🚨🚨 **DEPRECATED** 🚨🚨🚨 + +We now ship Google depot_tools with CMake during the configure step. +No manual setup is required. + +--- + ## Build from Source Clone the repository diff --git a/doc/setup-gn.md b/doc/setup-gn.md index c7123f24..77ce3762 100644 --- a/doc/setup-gn.md +++ b/doc/setup-gn.md @@ -1,5 +1,12 @@ # Install Standalone Google `gn` Build Configuration Tool +🚨🚨🚨 **DEPRECATED** 🚨🚨🚨 + +We now ship Google `gn` as part of depot_tools with CMake during the configure step. +No manual setup is required. + +--- + `gn` -- short for *generate Ninja* -- is Google's take on CMake. ## Build from Source diff --git a/doc/setup.md b/doc/setup.md index 85968d81..393e7fd6 100644 --- a/doc/setup.md +++ b/doc/setup.md @@ -118,7 +118,10 @@ Otherwise, there will be runtime errors: the client will see a data structure w/ ### `-DWITH_V8`: Enable WebAssembly execution backend with V8 engine. -Requirements: see [Building with V8](setup-building-with-V8.md) + +~~Requirements: see [Building with V8](setup-building-with-V8.md)~~ + +All requirements are automatically set up during CMake configure and build steps. - `-DBUILD_WITH_V8=ON` -- Build mu*t*able with the WebAssembly-based execution backend.