doc(bootstrap): add top-level doc-comment to utils/tarball.rs

2024-03-14 18:31:09 -05:00 · 2024-03-14 18:31:09 -05:00 · a0bb25f11c
commit a0bb25f11c
parent fd27e8745f
1 changed files with 7 additions and 0 deletions
--- a/src/bootstrap/src/utils/tarball.rs
+++ b/src/bootstrap/src/utils/tarball.rs
@ -1,3 +1,10 @@
+//! Facilitates the management and generation of tarballs.
+//!
+//! Tarballs efficiently hold Rust compiler build artifacts and
+//! capture a snapshot of each boostrap stage.
+//! In uplifting, a tarball from Stage N captures essential components
+//! to assemble Stage N + 1 compiler.
+
 use std::{
    path::{Path, PathBuf},
    process::Command,