diff options
| author | Carlos Martín Nieto <cmn@dwim.me> | 2013-09-20 23:14:52 +0200 |
|---|---|---|
| committer | Carlos Martín Nieto <cmn@dwim.me> | 2013-10-02 06:42:27 +0200 |
| commit | 36a241acbb39aa46cf5f7807aebd92e45f2f5eaf (patch) | |
| tree | 135b34a3eff7c0d967dbd671a6dec30e26cfbec8 /include/git2/clone.h | |
| parent | fdc7e5e35efa072a145cf318457055f60c9b21eb (diff) | |
| download | libgit2-36a241acbb39aa46cf5f7807aebd92e45f2f5eaf.tar.gz | |
clone: mention clone_into in the clone documentation
Make the difference more explicit.
Diffstat (limited to 'include/git2/clone.h')
| -rw-r--r-- | include/git2/clone.h | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/include/git2/clone.h b/include/git2/clone.h index bd602fb7a..a341a413c 100644 --- a/include/git2/clone.h +++ b/include/git2/clone.h @@ -61,8 +61,11 @@ typedef struct git_clone_options { #define GIT_CLONE_OPTIONS_INIT {GIT_CLONE_OPTIONS_VERSION, {GIT_CHECKOUT_OPTS_VERSION, GIT_CHECKOUT_SAFE_CREATE}} /** - * Clone a remote repository, and checkout the branch pointed to by the remote - * HEAD. + * Clone a remote repository. + * + * This version handles the simple case. If you'd like to create the + * repository or remote with non-default settings, you can create and + * configure them and then use `git_clone_into()`. * * @param out pointer that will receive the resulting repository object * @param url the remote repository to clone |