about summary refs log tree commit diff
path: root/src
diff options
context:
space:
mode:
authorChris Denton <christophersdenton@gmail.com>2025-04-13 03:07:07 +0000
committerGitHub <noreply@github.com>2025-04-13 03:07:07 +0000
commitb0c0ff97b61bb7ff426bcbeba1cd3c82ba3d5b66 (patch)
treec167b37515f291ec95cd72d33327a1820081cec5 /src
parent546367ef69a0b4349d5056f21e3649d108da2683 (diff)
parent394610b6d6b0bde38f75b7cc41ec1931bb7f0323 (diff)
downloadrust-b0c0ff97b61bb7ff426bcbeba1cd3c82ba3d5b66.tar.gz
rust-b0c0ff97b61bb7ff426bcbeba1cd3c82ba3d5b66.zip
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.
Diffstat (limited to 'src')
-rw-r--r--src/doc/rustc-dev-guide/src/building/optimized-build.md9
1 files changed, 7 insertions, 2 deletions
diff --git a/src/doc/rustc-dev-guide/src/building/optimized-build.md b/src/doc/rustc-dev-guide/src/building/optimized-build.md
index 0849464eab3..62dfaca89d2 100644
--- a/src/doc/rustc-dev-guide/src/building/optimized-build.md
+++ b/src/doc/rustc-dev-guide/src/building/optimized-build.md
@@ -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"