summaryrefslogtreecommitdiff
path: root/include/git2/push.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/git2/push.h')
-rw-r--r--include/git2/push.h21
1 files changed, 7 insertions, 14 deletions
diff --git a/include/git2/push.h b/include/git2/push.h
index cbf115661..7bd1377e9 100644
--- a/include/git2/push.h
+++ b/include/git2/push.h
@@ -128,12 +128,14 @@ GIT_EXTERN(int) git_push_update_tips(
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
- * have been updated as requested), you need to call both
- * `git_push_unpack_ok` and `git_push_status_foreach`. The remote
- * repository might have refused to update some or all of the references.
+ * This function will return an error in case of a protocol error or
+ * the server being unable to unpack the data we sent.
+ *
+ * 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
*
@@ -142,15 +144,6 @@ GIT_EXTERN(int) git_push_update_tips(
GIT_EXTERN(int) git_push_finish(git_push *push);
/**
- * Check if remote side successfully unpacked
- *
- * @param push The push object
- *
- * @return true if remote side successfully unpacked, false otherwise
- */
-GIT_EXTERN(int) git_push_unpack_ok(const git_push *push);
-
-/**
* Invoke callback `cb' on each status entry
*
* For each of the updated references, we receive a status report in the