Rollup merge of #139691 - Kobzol:opt-dist-docs, r=jieyouxu

Document that `opt-dist` requires metrics to be enabled

Suggested in https://github.com/rust-lang/rust/pull/139686.
This commit is contained in:
Chris Denton 2025-04-13 03:07:07 +00:00 committed by GitHub
commit b0c0ff97b6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -109,11 +109,16 @@ like Python or LLVM.
Here is an example of how can `opt-dist` be used locally (outside of CI):
1. Build the tool with the following command:
1. Enable metrics in your `bootstrap.toml` file, because `opt-dist` expects it to be enabled:
```toml
[build]
metrics = true
```
2. Build the tool with the following command:
```bash
./x build tools/opt-dist
```
2. Run the tool with the `local` mode and provide necessary parameters:
3. Run the tool with the `local` mode and provide necessary parameters:
```bash
./build/host/stage0-tools-bin/opt-dist local \
--target-triple <target> \ # select target, e.g. "x86_64-unknown-linux-gnu"