user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add clarifying documentation to require_and_update_submodule.

Browse source
This commit is contained in:
Eric Huss 2024-07-27 08:06:20 -07:00
parent 78ee5d057b
commit 0f387eb39b
1 changed files with 4 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

5
src/bootstrap/src/lib.rs
View file

@ -594,8 +594,11 @@ impl Build {
/// Updates a submodule, and exits with a failure if submodule management
/// is disabled and the submodule does not exist.
///
/// The given submodule name should be its path relative to the root of
/// the main repository.
///
/// The given `err_hint` will be shown to the user if the submodule is not
/// checked out.
/// checked out and submodule management is disabled.
pub fn require_and_update_submodule(&self, submodule: &str, err_hint: Option<&str>) {
// When testing bootstrap itself, it is much faster to ignore
// submodules. Almost all Steps work fine without their submodules.