Skip to content

Commit 0f387eb

Browse files
committed
Add clarifying documentation to require_and_update_submodule.
1 parent 78ee5d0 commit 0f387eb

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

src/bootstrap/src/lib.rs

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

0 commit comments

Comments
 (0)