summaryrefslogtreecommitdiff
path: root/include/git2/remote.h
diff options
context:
space:
mode:
authorBen Straub <bs@github.com>2012-10-23 09:21:32 -0700
committerBen Straub <bs@github.com>2012-10-23 09:23:44 -0700
commitc70ad945cdf9b92e54e7e8a5769b1f35ea19ebbd (patch)
tree6c334c62c35799dc22d0b4f80e60f2e318240786 /include/git2/remote.h
parent2dae54a9419aaeb9d3d6a8eb6a28e13edb41bd58 (diff)
downloadlibgit2-c70ad945cdf9b92e54e7e8a5769b1f35ea19ebbd.tar.gz
Update doc strings, warn about callback perf
Diffstat (limited to 'include/git2/remote.h')
-rw-r--r--include/git2/remote.h4
1 files changed, 3 insertions, 1 deletions
diff --git a/include/git2/remote.h b/include/git2/remote.h
index ca75126f9..35b1f2e5b 100644
--- a/include/git2/remote.h
+++ b/include/git2/remote.h
@@ -184,7 +184,9 @@ GIT_EXTERN(int) git_remote_ls(git_remote *remote, git_headlist_cb list_cb, void
*
* @param remote the remote to download from
* @param filename where to store the temporary filename
- * @param progress_cb function to call with progress information
+ * @param progress_cb function to call with progress information. Be aware that
+ * this is called inline with network and indexing operations, so performance
+ * may be affected.
* @param progress_payload payload for the progress callback
* @return 0 or an error code
*/