Skip to content

Commit

Permalink
[Doc] Update V8-related documentation.
Browse files Browse the repository at this point in the history
Mark the manual setup of depot_tools and gn as deprecated.
  • Loading branch information
ImmanuelHaffner committed May 4, 2024
1 parent 17eca67 commit 9b4cb9d
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 2 deletions.
9 changes: 8 additions & 1 deletion doc/setup-building-with-V8.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
7 changes: 7 additions & 0 deletions doc/setup-depot_tools.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
7 changes: 7 additions & 0 deletions doc/setup-gn.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
5 changes: 4 additions & 1 deletion doc/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 9b4cb9d

Please sign in to comment.