add doc to all the newly created modules

Author: Shourya742

src/bootstrap/src/core/config/config.rs

@@ -5,7 +5,7 @@
 //! This module orchestrates the overall configuration parsing process by leveraging
 //! logic from `parsing.rs` and provides top-level methods for initializing (`Config::parse()`)
 //! and querying the comprehensive configuration state. It also contains various utility
-//! methods that operate on the overall configuration.
+//! methods that operate on the overall config struct.
 
 use std::cell::Cell;
 use std::collections::{BTreeSet, HashMap, HashSet};

src/bootstrap/src/core/config/toml/build.rs

@@ -1,3 +1,11 @@
+//! This module defines the `Build` struct, which represents the `[build]` table
+//! in the `bootstrap.toml` configuration file.
+//!
+//! The `[build]` table contains global options that influence the overall build process,
+//! such as default host and target triples, paths to tools, build directories, and
+//! various feature flags. These options apply across different stages and components
+//! unless specifically overridden by other configuration sections or command-line flags.
+
 use serde::{Deserialize, Deserializer};
 
 use crate::core::config::toml::common::StringOrBool;

src/bootstrap/src/core/config/toml/common.rs

@@ -1,3 +1,11 @@
+//! This module defines common types, enums, and helper functions used across
+//! various TOML configuration sections within `bootstrap.toml`.
+//!
+//! It provides shared definitions for:
+//! - Data types that are serialized from TOML.
+//! - Utility enums for specific configuration options.
+//! - Helper functions for managing configuration values.
+
 use std::fmt::Display;
 
 use serde::{Deserialize, Deserializer};

src/bootstrap/src/core/config/toml/dist.rs

@@ -1,3 +1,10 @@
+//! This module defines the `Dist` struct, which represents the `[dist]` table
+//! in the `bootstrap.toml` configuration file.
+//!
+//! The `[dist]` table contains options related to the distribution process,
+//! including signing, uploading artifacts, source tarballs, compression settings,
+//! and inclusion of specific tools.
+
 use serde::{Deserialize, Deserializer};
 
 use crate::core::config::set;
@@ -17,6 +24,8 @@ define_config! {
 }
 
 impl Config {
+    /// Applies distribution-related configuration from the `Dist` struct
+    /// to the global `Config` structure.
     pub fn apply_dist_config(&mut self, toml_dist: Option<Dist>) {
         if let Some(dist) = toml_dist {
             let Dist {

src/bootstrap/src/core/config/toml/gcc.rs

@@ -1,3 +1,9 @@
+//! This module defines the `Gcc` struct, which represents the `[gcc]` table
+//! in the `bootstrap.toml` configuration file.
+//!
+//! The `[gcc]` table contains options specifically related to building or
+//! acquiring the GCC compiler for use within the Rust build process.
+
 use serde::{Deserialize, Deserializer};
 
 use crate::core::config::GccCiMode;
@@ -12,6 +18,8 @@ define_config! {
 }
 
 impl Config {
+    /// Applies GCC-related configuration from the `TomlGcc` struct to the
+    /// global `Config` structure.
     pub fn apply_gcc_config(&mut self, toml_gcc: Option<Gcc>) {
         if let Some(gcc) = toml_gcc {
             self.gcc_ci_mode = match gcc.download_ci_gcc {

src/bootstrap/src/core/config/toml/install.rs

@@ -1,3 +1,11 @@
+//! This module defines the `Install` struct, which represents the `[install]` table
+//! in the `bootstrap.toml` configuration file.
+//!
+//! The `[install]` table contains options that specify the installation paths
+//! for various components of the Rust toolchain. These paths determine where
+//! executables, libraries, documentation, and other files will be placed
+//! during the `install` stage of the build.
+
 use serde::{Deserialize, Deserializer};
 
 use crate::core::config::set;
@@ -18,6 +26,8 @@ define_config! {
 }
 
 impl Config {
+    /// Applies installation-related configuration from the `Install` struct
+    /// to the global `Config` structure.
     pub fn apply_install_config(&mut self, toml_install: Option<Install>) {
         if let Some(install) = toml_install {
             let Install { prefix, sysconfdir, docdir, bindir, libdir, mandir, datadir } = install;

src/bootstrap/src/core/config/toml/llvm.rs

@@ -1,3 +1,6 @@
+//! This module defines the `Llvm` struct, which represents the `[llvm]` table
+//! in the `bootstrap.toml` configuration file.
+
 use serde::{Deserialize, Deserializer};
 
 use crate::core::config::set;

src/bootstrap/src/core/config/toml/macros.rs

@@ -1,3 +1,11 @@
+//! This module define two macros:
+//!
+//! The `define_config!` macro avoids the use of `#[derive(Deserialize)]` to reduce compile time
+//! and binary size, particularly for the bootstrap binary.
+//!
+//! The `check_ci_llvm!` macro provides a compile-time assertion to ensure certain settings are
+//! not used when `download-ci-llvm` is enabled.
+
 // We are using a decl macro instead of a derive proc macro here to reduce the compile time of bootstrap.
 #[macro_export]
 macro_rules! define_config {

src/bootstrap/src/core/config/toml/merge.rs

@@ -1,3 +1,4 @@
+//! Provides traits and implementations for merging configuration structures.
 use std::collections::HashSet;
 use std::path::PathBuf;
 

src/bootstrap/src/core/config/toml/mod.rs

@@ -1,10 +1,11 @@
 //! This module defines the structures that directly mirror the `bootstrap.toml`
-//! file's format. These types are used for `serde` deserialization, serving as an
-//! intermediate representation that gets processed and merged into the final `Config`
-//! types from the `types` module.
+//! file's format. These types are used for `serde` deserialization.
 //!
-//! It also houses the `Merge` trait and `define_config!` macro, which are essential
-//! for handling these raw TOML structures.
+//! Crucially, this module also houses the core logic for loading, parsing, and merging
+//! these raw TOML configurations from various sources (the main `bootstrap.toml`,
+//! included files, profile defaults, and command-line overrides). This processed
+//! TOML data then serves as an intermediate representation, which is further
+//! transformed and applied to the final [`Config`] struct.
 
 use serde::Deserialize;
 use serde_derive::Deserialize;

src/bootstrap/src/core/config/toml/rust.rs

@@ -1,3 +1,6 @@
+//! This module defines the `Rust` struct, which represents the `[rust]` table
+//! in the `bootstrap.toml` configuration file.
+
 use std::str::FromStr;
 
 use serde::{Deserialize, Deserializer};

src/bootstrap/src/core/config/toml/target.rs

@@ -1,3 +1,17 @@
+//! This module defines the structures and logic for handling target-specific configuration
+//! within the `bootstrap.toml` file. This allows you to customize build settings, tools,
+//! and flags for individual compilation targets.
+//!
+//! It includes:
+//!
+//! * [`TomlTarget`]: This struct directly mirrors the `[target.<triple>]` sections in your
+//!   `bootstrap.toml`. It's used for deserializing raw TOML data for a specific target.
+//! * [`Target`]: This struct represents the processed and validated configuration for a
+//!   build target, which is is stored in the main [`Config`] structure.
+//! * [`Config::apply_target_config`]: This method processes the `TomlTarget` data and
+//!   applies it to the global [`Config`], ensuring proper path resolution, validation,
+//!   and integration with other build settings.
+
 use std::collections::HashMap;
 
 use serde::{Deserialize, Deserializer};