diff options
Diffstat (limited to 'include/git2/clone.h')
| -rw-r--r-- | include/git2/clone.h | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/include/git2/clone.h b/include/git2/clone.h index 40292ed59..c4dfc652b 100644 --- a/include/git2/clone.h +++ b/include/git2/clone.h @@ -29,9 +29,12 @@ GIT_BEGIN_DECL * @param out pointer that will receive the resulting repository object * @param origin_url repository to clone from * @param workdir_path local directory to clone to - * @param fetch_stats pointer to structure that receives fetch progress information (may be NULL) - * @param checkout_opts options for the checkout step (may be NULL) - * @return 0 on success, GIT_ERROR otherwise (use giterr_last for information about the error) + * @param fetch_stats pointer to structure that receives fetch progress + * information (may be NULL) + * @param checkout_opts options for the checkout step. If NULL, no checkout + * is performed + * @return 0 on success, GIT_ERROR otherwise (use giterr_last for information + * about the error) */ GIT_EXTERN(int) git_clone(git_repository **out, const char *origin_url, |