Skip to content

Commit

Permalink
document bootstrap tool module
Browse files Browse the repository at this point in the history
Signed-off-by: onur-ozkan <[email protected]>
  • Loading branch information
onur-ozkan committed Feb 3, 2025
1 parent 44cc009 commit 79b6c4b
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
2 changes: 1 addition & 1 deletion src/bootstrap/src/core/build_steps/compile.rs
Original file line number Diff line number Diff line change
Expand Up @@ -840,7 +840,7 @@ fn cp_rustc_component_to_ci_sysroot(builder: &Builder<'_>, sysroot: &Path, conte
/// Low-level implementation of the compiler's compilation process.
///
/// DO NOT `pub` the fields of this type and AVOID using it anywhere
/// unless its in the `Assemble` step.
/// unless it's in the `Assemble` step.
///
/// If you want to build a compiler for a specific stage and target, use
/// `Builder::compiler` instead.
Expand Down
11 changes: 11 additions & 0 deletions src/bootstrap/src/core/build_steps/tool.rs
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
//! This module handles building and managing various tools in bootstrap
//! build system.
//!
//! **What It Does**
//! - Defines how tools are built, configured and installed.
//! - Manages tool dependencies and build steps.
//! - Copies built tool binaries to the correct locations.
//!
//! Each tool **MUST** utilize `ToolBuild` inside their `Step` logic and
//! they should never prepare `cargo` invocations manually.
use std::path::PathBuf;
use std::{env, fs};

Expand Down

0 comments on commit 79b6c4b

Please sign in to comment.