Skip to content

Commit 912b22f

Browse files
committed
add doc comment to rustc_cfg::RustcCfgConfig
1 parent fad3823 commit 912b22f

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

crates/project-model/src/rustc_cfg.rs

+8
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,14 @@ use rustc_hash::FxHashMap;
77

88
use crate::{cfg_flag::CfgFlag, utf8_stdout, ManifestPath, Sysroot};
99

10+
/// Determines how `rustc --print cfg` is discovered and invoked.
11+
///
12+
/// There options are supported:
13+
/// - [`RustcCfgConfig::Cargo`], which relies on `cargo rustc --print cfg`
14+
/// and `RUSTC_BOOTSTRAP`.
15+
/// - [`RustcCfgConfig::Explicit`], which uses an explicit path to the `rustc`
16+
/// binary in the sysroot.
17+
/// - [`RustcCfgConfig::Discover`], which uses [`toolchain::rustc`].
1018
pub(crate) enum RustcCfgConfig<'a> {
1119
Cargo(&'a ManifestPath),
1220
Explicit(&'a Sysroot),

0 commit comments

Comments
 (0)