Document callback-triggered cancellation

This commit is contained in:
Ben Straub 2013-02-05 12:03:41 -08:00
parent fe95ac1b67
commit b71bac9d2b

View File

@ -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);