Skip to content

Commit 04bd18b

Browse files
dbortfacebook-github-bot
authored andcommitted
Clarify that buck2 version is important (#734)
Summary: Pull Request resolved: #734 The buck2 commandline tool version must be compatible with the buck2 prelude version. Make it clear that users must grab a specific version of buck2. Reviewed By: larryliu0820 Differential Revision: D50093420 fbshipit-source-id: e7769557791e200066e033d3c443e3f27db83354
1 parent 809cc4b commit 04bd18b

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

docs/source/getting-started-setup.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -158,9 +158,13 @@ all the operators and backends.
158158

159159
You will need the following prerequisits for this section:
160160

161-
* **Zstandard**, or `zstd`, command line tool — install by running `pip3 install zstd`.
161+
* The `zstd` command line tool — install by running `pip3 install zstd`.
162162

163-
* A prebuilt Buck2 archive for your system from [the Buck2 repo](https://github.com/facebook/buck2/releases/tag/2023-07-18).
163+
* Version `2023-07-18` of the `buck2` commandline tool — you can download a
164+
prebuilt archive for your system from [the Buck2
165+
repo](https://github.com/facebook/buck2/releases/tag/2023-07-18). Note that
166+
the version is important, and newer or older versions may not work with the
167+
version of the buck2 prelude used by the ExecuTorch repo.
164168

165169
Complete the following steps:
166170

docs/website/docs/tutorials/00_setting_up_executorch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ Follow [AOT Setup: Step 2](./00_setting_up_executorch.md#step-2-clone-the-execut
8383
### Step 1: Install buck2
8484

8585
- If you don't have the `zstd` commandline tool, install it with `pip install zstd`
86-
- Download a prebuilt buck2 archive for your system from https://github.com/facebook/buck2/releases/tag/2023-07-18
86+
- Download a prebuilt buck2 archive for your system from the https://github.com/facebook/buck2/releases/tag/2023-07-18 release page. Note that the version is important, and newer or older versions may not work with the version of the buck2 prelude used by the ExecuTorch repo.
8787
- Decompress with the following command (filename depends on your system)
8888

8989
```bash

0 commit comments

Comments
 (0)