Commit 85a6d5f4 by Carlos Martín Nieto

push: reword comment on finish()

This should make it clearer what the return value implies.
parent d524b2d3
...@@ -128,12 +128,14 @@ GIT_EXTERN(int) git_push_update_tips( ...@@ -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
* *
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment