diff options
| author | Stuart Cook <Zalathar@users.noreply.github.com> | 2025-09-04 10:02:00 +1000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-09-04 10:02:00 +1000 |
| commit | 9867486fe8e1a1dc261aaef8922a7eda764ef91d (patch) | |
| tree | 561942ed8a168515ab4258a014ef78d10a81aa67 /src/doc/rustc-dev-guide | |
| parent | 1456b67ded45356e44d71aec334f801cb20567d6 (diff) | |
| parent | df5896a8821e5ef0531a986beb346bb0930ce611 (diff) | |
| download | rust-9867486fe8e1a1dc261aaef8922a7eda764ef91d.tar.gz rust-9867486fe8e1a1dc261aaef8922a7eda764ef91d.zip | |
Rollup merge of #146127 - Kobzol:rename-tool-rustc, r=jieyouxu
Rename `ToolRustc` to `ToolRustcPrivate` I think that this name gets the point across much better. r? ````@jieyouxu````
Diffstat (limited to 'src/doc/rustc-dev-guide')
| -rw-r--r-- | src/doc/rustc-dev-guide/src/building/bootstrapping/writing-tools-in-bootstrap.md | 7 |
1 files changed, 2 insertions, 5 deletions
diff --git a/src/doc/rustc-dev-guide/src/building/bootstrapping/writing-tools-in-bootstrap.md b/src/doc/rustc-dev-guide/src/building/bootstrapping/writing-tools-in-bootstrap.md index 41d0cf8d9fb..c3660e24b15 100644 --- a/src/doc/rustc-dev-guide/src/building/bootstrapping/writing-tools-in-bootstrap.md +++ b/src/doc/rustc-dev-guide/src/building/bootstrapping/writing-tools-in-bootstrap.md @@ -11,11 +11,8 @@ There are three types of tools you can write in bootstrap: Use this for tools that rely on the locally built std. The output goes into the "stageN-tools" directory. This mode is rarely used, mainly for `compiletest` which requires `libtest`. -- **`Mode::ToolRustc`** - Use this for tools that depend on both the locally built `rustc` and the target `std`. This is more complex than - the other modes because the tool must be built with the same compiler used for `rustc` and placed in the "stageN-tools" - directory. When you choose `Mode::ToolRustc`, `ToolBuild` implementation takes care of this automatically. - If you need to use the builder’s compiler for something specific, you can get it from `ToolBuildResult`, which is +- **`Mode::ToolRustcPrivate`** + Use this for tools that use the `rustc_private` mechanism, and thus depend on the locally built `rustc` and its rlib artifacts. This is more complex than the other modes because the tool must be built with the same compiler used for `rustc` and placed in the "stageN-tools" directory. When you choose `Mode::ToolRustcPrivate`, `ToolBuild` implementation takes care of this automatically. If you need to use the builder’s compiler for something specific, you can get it from `ToolBuildResult`, which is returned by the tool's [`Step`]. Regardless of the tool type you must return `ToolBuildResult` from the tool’s [`Step`] implementation and use `ToolBuild` inside it. |
