summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorDaniel Rodríguez Troitiño <drodrigueztroitino@yahoo.es>2013-05-26 17:29:00 +0200
committerDaniel Rodríguez Troitiño <drodrigueztroitino@yahoo.es>2013-05-26 17:29:00 +0200
commitf8bd730cd90a1e6219447cc9c05f41295d42bbcb (patch)
tree7f45369786a2eb70c26a9ea8de4754ccece54735 /include
parent0d77647adc1f76df66e437e6442d7f7706e2c38e (diff)
downloadlibgit2-f8bd730cd90a1e6219447cc9c05f41295d42bbcb.tar.gz
Fix documentation of git_branch_delete.
The reference should be freed by the user, not the library.
Diffstat (limited to 'include')
-rw-r--r--include/git2/branch.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/include/git2/branch.h b/include/git2/branch.h
index d1838a63a..de414e9b0 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.