about summary refs log tree commit diff
path: root/src/bootstrap
diff options
context:
space:
mode:
authorTrevor Gross <t.gross35@gmail.com>2025-02-23 14:30:28 -0500
committerGitHub <noreply@github.com>2025-02-23 14:30:28 -0500
commite8342e7d42bf789b6d69caaeafd547f6e7deadc2 (patch)
tree4c3684743b93733e5d29c95c614c50c2a17d3a63 /src/bootstrap
parent781203dd8744d8229fedbb771d58b072595217e5 (diff)
parent54dd4c87bea51dca48dc3464df3d489c2a717b09 (diff)
downloadrust-e8342e7d42bf789b6d69caaeafd547f6e7deadc2.tar.gz
rust-e8342e7d42bf789b6d69caaeafd547f6e7deadc2.zip
Rollup merge of #137452 - Shourya742:2025-02-23-add-module-level-doc-for-core-metadata, r=Kobzol
bootstrap: add module docs for core:metadata

Add module doc for bootstrap:core:metadata
Diffstat (limited to 'src/bootstrap')
-rw-r--r--src/bootstrap/src/core/metadata.rs7
1 files changed, 7 insertions, 0 deletions
diff --git a/src/bootstrap/src/core/metadata.rs b/src/bootstrap/src/core/metadata.rs
index 983674d2c68..01cbf662940 100644
--- a/src/bootstrap/src/core/metadata.rs
+++ b/src/bootstrap/src/core/metadata.rs
@@ -1,3 +1,10 @@
+//! This module interacts with Cargo metadata to collect and store information about
+//! the packages in the Rust workspace.
+//!
+//! It runs `cargo metadata` to gather details about each package, including its name,
+//! source, dependencies, targets, and available features. The collected metadata is then
+//! used to update the `Build` structure, ensuring proper dependency resolution and
+//! compilation flow.
 use std::collections::BTreeMap;
 use std::path::PathBuf;