about summary refs log tree commit diff
diff options
context:
space:
mode:
authorGuillaume Gomez <guillaume1.gomez@gmail.com>2024-04-16 15:19:11 +0200
committerGitHub <noreply@github.com>2024-04-16 15:19:11 +0200
commit4232361d89d36ce84b4bc144cbcb3467d8127e7b (patch)
treea8ff2c04bb1fd9022ba70fd62450eb0b95ff5bed
parent26b6a234a1d447bda7c61d3801961798f7b9c5aa (diff)
parenta0bb25f11c99905b03785de0b5173f9b1bd7bded (diff)
Rollup merge of #122521 - bnleft:master, r=albertlarsan68
doc(bootstrap): add top-level doc-comment to utils/tarball.rs
-rw-r--r--src/bootstrap/src/utils/tarball.rs7
1 files changed, 7 insertions, 0 deletions
diff --git a/src/bootstrap/src/utils/tarball.rs b/src/bootstrap/src/utils/tarball.rs
index 89fcac2a84b..cc86e3bab0c 100644
--- 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,