proxmox-mirrors/libgit2
1
0
Fork 0
mirror of https://git.proxmox.com/git/libgit2 synced 2025-05-04 19:50:19 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update doc strings, warn about callback perf

Browse Source
This commit is contained in:
Ben Straub 2012-10-23 09:21:32 -07:00
parent 2dae54a941
commit c70ad945cd
2 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
include/git2/clone.h
View File

@ -29,8 +29,10 @@ GIT_BEGIN_DECL
* @param out pointer that will receive the resulting repository object * @param out pointer that will receive the resulting repository object
* @param origin_url repository to clone from * @param origin_url repository to clone from
* @param workdir_path local directory to clone to * @param workdir_path local directory to clone to
* @param fetch_stats pointer to structure that receives fetch progress * @param fetch_progress_cb optional callback for fetch progress. Be aware that
* information (may be NULL) * 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 * @param checkout_opts options for the checkout step. If NULL, no checkout
* is performed * is performed
* @return 0 on success, GIT_ERROR otherwise (use giterr_last for information * @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 out pointer that will receive the resulting repository object
* @param origin_url repository to clone from * @param origin_url repository to clone from
* @param dest_path local directory to clone to * @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) * @return 0 on success, GIT_ERROR otherwise (use giterr_last for information about the error)
*/ */
GIT_EXTERN(int) git_clone_bare( GIT_EXTERN(int) git_clone_bare(

4
include/git2/remote.h
View File

@ -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 remote the remote to download from
* @param filename where to store the temporary filename * @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 * @param progress_payload payload for the progress callback
* @return 0 or an error code * @return 0 or an error code
*/ */