summaryrefslogtreecommitdiff
path: root/include/git2
diff options
context:
space:
mode:
Diffstat (limited to 'include/git2')
-rw-r--r--include/git2/remote.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/include/git2/remote.h b/include/git2/remote.h
index d57321f03..88040d49c 100644
--- a/include/git2/remote.h
+++ b/include/git2/remote.h
@@ -455,7 +455,8 @@ struct git_remote_callbacks {
/**
* Textual progress from the remote. Text send over the
* progress side-band will be passed to this function (this is
- * the 'counting objects' output.
+ * the 'counting objects' output. This callback should return a value less
+ * than zero to cancel the operation.
*/
int (*progress)(const char *str, int len, void *data);