Commit 8af503bc85a92242bd698cca1e8594af909811c6

Michael Schubert 2012-04-28T20:49:05

remote: add more doc on git_remote_free

1
2
3
4
5
6
7
8
9
10
11
12
13
14
diff --git a/include/git2/remote.h b/include/git2/remote.h
index 09b927e..7af4148 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);