From b71bac9d2b1a3c4b87fdc808b13d9cd4b70ea978 Mon Sep 17 00:00:00 2001 From: Ben Straub Date: Tue, 5 Feb 2013 12:03:41 -0800 Subject: [PATCH] Document callback-triggered cancellation --- include/git2/indexer.h | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/include/git2/indexer.h b/include/git2/indexer.h index 0e62835ce..151f5b4e7 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);