summaryrefslogtreecommitdiff
path: root/include/git2/clone.h
diff options
context:
space:
mode:
authornulltoken <emeric.fermas@gmail.com>2012-10-15 06:12:57 +0200
committernulltoken <emeric.fermas@gmail.com>2012-10-15 20:40:37 +0200
commit4d968f134b8ccd20e5a5b26ee160372076c55f5c (patch)
tree04aa9a447bb977f2d14bef0cc876ffb19f1db3e0 /include/git2/clone.h
parent1ddc537c779a5796c4ed1d5fc2e41bd38cdeb394 (diff)
downloadlibgit2-4d968f134b8ccd20e5a5b26ee160372076c55f5c.tar.gz
clone: Explicit support of no-checkout option
Diffstat (limited to 'include/git2/clone.h')
-rw-r--r--include/git2/clone.h9
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,