summaryrefslogtreecommitdiff
path: root/include/git2/remote.h
diff options
context:
space:
mode:
authorMichael Schubert <schu@schu.io>2012-04-28 20:49:05 +0200
committerMichael Schubert <schu@schu.io>2012-04-28 20:49:05 +0200
commit8af503bc85a92242bd698cca1e8594af909811c6 (patch)
treee6685c15907b451165089232b911e6207ae37989 /include/git2/remote.h
parent9738e2cd2c57aeaa474315108af2ac5556b93843 (diff)
downloadlibgit2-8af503bc85a92242bd698cca1e8594af909811c6.tar.gz
remote: add more doc on git_remote_free
Diffstat (limited to 'include/git2/remote.h')
-rw-r--r--include/git2/remote.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/include/git2/remote.h b/include/git2/remote.h
index 09b927e28..7af4148dc 100644
--- a/include/git2/remote.h
+++ b/include/git2/remote.h
@@ -176,6 +176,9 @@ GIT_EXTERN(void) git_remote_disconnect(git_remote *remote);
/**
* Free the memory associated with a remote
*
+ * This also disconnects from the remote, if the connection
+ * has not been closed yet (using git_remote_disconnect).
+ *
* @param remote the remote to free
*/
GIT_EXTERN(void) git_remote_free(git_remote *remote);