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

Merge pull request #1340 from schu/push-docs

Browse Source 
push: improve docs on success / failure of git_push_finish
This commit is contained in:
Vicent Martí 2013-02-14 11:33:47 -08:00
commit c9d17120ce
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
include/git2/push.h
View File

@ -82,6 +82,11 @@ GIT_EXTERN(int) git_push_update_tips(git_push *push);
/**
* Actually push all given refspecs
*
* Note: To check if the push was successful (i.e. all remote references
* have been updated as requested), you need to call both
* `git_push_unpack_ok` and `git_push_status_foreach`. The remote
* repository might refused to update some or all of the references.
*
* @param push The push object
*
* @return 0 or an error code
@ -100,6 +105,11 @@ GIT_EXTERN(int) git_push_unpack_ok(git_push *push);
/**
* Call callback `cb' on each status
*
* For each of the updated references, we receive a status report in the
* form of `ok refs/heads/master` or `ng refs/heads/master <msg>`.
* `msg != NULL` means the reference has not been updated for the given
* reason.
*
* @param push The push object
* @param cb The callback to call on each object
*