From a0bb25f11c99905b03785de0b5173f9b1bd7bded Mon Sep 17 00:00:00 2001 From: Bryant Le Date: Thu, 14 Mar 2024 18:31:09 -0500 Subject: [PATCH] doc(bootstrap): add top-level doc-comment to utils/tarball.rs --- src/bootstrap/src/utils/tarball.rs | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/bootstrap/src/utils/tarball.rs b/src/bootstrap/src/utils/tarball.rs index 03f56cba29d8d..47f135fae9ed7 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,