Commit b71bac9d2b1a3c4b87fdc808b13d9cd4b70ea978

Ben Straub 2013-02-05T12:03:41

Document callback-triggered cancellation

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
diff --git a/include/git2/indexer.h b/include/git2/indexer.h
index 0e62835..151f5b4 100644
--- a/include/git2/indexer.h
+++ b/include/git2/indexer.h
@@ -25,7 +25,11 @@ typedef struct git_transfer_progress {
 
 
 /**
- * Type for progress callbacks during indexing
+ * Type for progress callbacks during indexing.  Return a value less than zero
+ * to cancel the transfer.
+ *
+ * @param stats Structure containing information about the state of the transfer
+ * @param payload Payload provided by caller
  */
 typedef int (*git_transfer_progress_callback)(const git_transfer_progress *stats, void *payload);