diff options
| author | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2024-02-27 18:48:29 +0100 |
|---|---|---|
| committer | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2024-02-27 18:48:29 +0100 |
| commit | 6560fecbdfba0d4b2bd874e26008fe5716891589 (patch) | |
| tree | e6afa036c237d9dff426b8227b6117d67068bb30 | |
| parent | aed59f0a510b4e47496d871051026c885bccc3a1 (diff) | |
| download | rust-6560fecbdfba0d4b2bd874e26008fe5716891589.tar.gz rust-6560fecbdfba0d4b2bd874e26008fe5716891589.zip | |
Add documentation on git_clone_root_dir
| -rw-r--r-- | build_system/src/utils.rs | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/build_system/src/utils.rs b/build_system/src/utils.rs index 56f1abaf198..d9c13fd143d 100644 --- a/build_system/src/utils.rs +++ b/build_system/src/utils.rs @@ -307,6 +307,10 @@ pub fn git_clone( git_clone_inner(to_clone, dest, shallow_clone, repo_name) } +/// This function differs from `git_clone` in how it handles *where* the repository will be cloned. +/// In `git_clone`, it is cloned in the provided path. In this function, the path you provide is +/// the parent folder. So if you pass "a" as folder and try to clone "b.git", it will be cloned into +/// `a/b`. pub fn git_clone_root_dir( to_clone: &str, dest_parent_dir: &Path, |