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

push: reword comment on finish()

Browse Source 
This should make it clearer what the return value implies.
This commit is contained in:
Carlos Martín Nieto 2014-12-10 18:49:01 +01:00
parent d524b2d3d1
commit 85a6d5f49c
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
include/git2/push.h
View File

@ -128,12 +128,14 @@ GIT_EXTERN(int) git_push_update_tips(
const char *reflog_message); const char *reflog_message);
/** /**
* Actually push all given refspecs * Perform the push
* *
* Note: To check if the push was successful (i.e. all remote references * This function will return an error in case of a protocol error or
* have been updated as requested), you need to call * the server being unable to unpack the data we sent.
* `git_push_status_foreach`. The remote *
* repository might have refused to update some or all of the references. * The return value does not reflect whether the server accepted or
* refused any reference updates. Use `git_push_status_foreach()` in
* order to find out which updates were accepted or rejected.
* *
* @param push The push object * @param push The push object
* *