diff options
| author | Ben Straub <bs@github.com> | 2012-10-23 09:21:32 -0700 |
|---|---|---|
| committer | Ben Straub <bs@github.com> | 2012-10-23 09:23:44 -0700 |
| commit | c70ad945cdf9b92e54e7e8a5769b1f35ea19ebbd (patch) | |
| tree | 6c334c62c35799dc22d0b4f80e60f2e318240786 /include | |
| parent | 2dae54a9419aaeb9d3d6a8eb6a28e13edb41bd58 (diff) | |
| download | libgit2-c70ad945cdf9b92e54e7e8a5769b1f35ea19ebbd.tar.gz | |
Update doc strings, warn about callback perf
Diffstat (limited to 'include')
| -rw-r--r-- | include/git2/clone.h | 11 | ||||
| -rw-r--r-- | include/git2/remote.h | 4 |
2 files changed, 11 insertions, 4 deletions
diff --git a/include/git2/clone.h b/include/git2/clone.h index dc49074dc..847295a21 100644 --- a/include/git2/clone.h +++ b/include/git2/clone.h @@ -29,8 +29,10 @@ 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 fetch_progress_cb optional callback for fetch progress. Be aware that + * this is called inline with network and indexing operations, so performance + * may be affected. + * @param fetch_progress_payload payload for fetch_progress_cb * @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 @@ -50,7 +52,10 @@ GIT_EXTERN(int) git_clone( * @param out pointer that will receive the resulting repository object * @param origin_url repository to clone from * @param dest_path local directory to clone to - * @param fetch_stats pointer to structure that receives fetch progress information (may be NULL) + * @param fetch_progress_cb optional callback for fetch progress. Be aware that + * this is called inline with network and indexing operations, so performance + * may be affected. + * @param fetch_progress_payload payload for fetch_progress_cb * @return 0 on success, GIT_ERROR otherwise (use giterr_last for information about the error) */ GIT_EXTERN(int) git_clone_bare( diff --git a/include/git2/remote.h b/include/git2/remote.h index ca75126f9..35b1f2e5b 100644 --- a/include/git2/remote.h +++ b/include/git2/remote.h @@ -184,7 +184,9 @@ GIT_EXTERN(int) git_remote_ls(git_remote *remote, git_headlist_cb list_cb, void * * @param remote the remote to download from * @param filename where to store the temporary filename - * @param progress_cb function to call with progress information + * @param progress_cb function to call with progress information. Be aware that + * this is called inline with network and indexing operations, so performance + * may be affected. * @param progress_payload payload for the progress callback * @return 0 or an error code */ |