mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add documentation on git_clone_root_dir

Browse Source
This commit is contained in:
Guillaume Gomez 2024-02-27 18:48:29 +01:00
parent aed59f0a51
commit 6560fecbdf
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
build_system/src/utils.rs
View File

@ -307,6 +307,10 @@ pub fn git_clone(
git_clone_inner(to_clone, dest, shallow_clone, repo_name) 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( pub fn git_clone_root_dir(
to_clone: &str, to_clone: &str,
dest_parent_dir: &Path, dest_parent_dir: &Path,