Skip to content

Commit 79b6c4b

Browse files
committed
document bootstrap tool module
Signed-off-by: onur-ozkan <work@onurozkan.dev>
1 parent 44cc009 commit 79b6c4b

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

src/bootstrap/src/core/build_steps/compile.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -840,7 +840,7 @@ fn cp_rustc_component_to_ci_sysroot(builder: &Builder<'_>, sysroot: &Path, conte
840840
/// Low-level implementation of the compiler's compilation process.
841841
///
842842
/// DO NOT `pub` the fields of this type and AVOID using it anywhere
843-
/// unless its in the `Assemble` step.
843+
/// unless it's in the `Assemble` step.
844844
///
845845
/// If you want to build a compiler for a specific stage and target, use
846846
/// `Builder::compiler` instead.

src/bootstrap/src/core/build_steps/tool.rs

+11
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
//! This module handles building and managing various tools in bootstrap
2+
//! build system.
3+
//!
4+
//! **What It Does**
5+
//! - Defines how tools are built, configured and installed.
6+
//! - Manages tool dependencies and build steps.
7+
//! - Copies built tool binaries to the correct locations.
8+
//!
9+
//! Each tool **MUST** utilize `ToolBuild` inside their `Step` logic and
10+
//! they should never prepare `cargo` invocations manually.
11+
112
use std::path::PathBuf;
213
use std::{env, fs};
314

0 commit comments

Comments
 (0)