Commit f8bd730cd90a1e6219447cc9c05f41295d42bbcb

Daniel Rodríguez Troitiño 2013-05-26T17:29:00

Fix documentation of git_branch_delete. The reference should be freed by the user, not the library.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
diff --git a/include/git2/branch.h b/include/git2/branch.h
index d1838a6..de414e9 100644
--- a/include/git2/branch.h
+++ b/include/git2/branch.h
@@ -58,7 +58,8 @@ GIT_EXTERN(int) git_branch_create(
  * Delete an existing branch reference.
  *
  * If the branch is successfully deleted, the passed reference
- * object will be freed and invalidated.
+ * object will be invalidated. The reference must be freed manually
+ * by the user.
  *
  * @param branch A valid reference representing a branch
  * @return 0 on success, or an error code.