summaryrefslogtreecommitdiff
path: root/include/git2/repository.h
diff options
context:
space:
mode:
authorRussell Belfer <rb@github.com>2012-11-27 15:28:48 -0800
committerRussell Belfer <rb@github.com>2012-11-27 15:28:48 -0800
commitca94e031fa21787ae6336f0aada1b01b2dd22077 (patch)
tree5113408a049178d14664f72cc1666655783d95d5 /include/git2/repository.h
parentc3fb7d04edecb68f0307dfaa48a311f0f72db90e (diff)
downloadlibgit2-ca94e031fa21787ae6336f0aada1b01b2dd22077.tar.gz
Various minor commenting fixes
Diffstat (limited to 'include/git2/repository.h')
-rw-r--r--include/git2/repository.h6
1 files changed, 5 insertions, 1 deletions
diff --git a/include/git2/repository.h b/include/git2/repository.h
index f1b55f433..e91108a33 100644
--- a/include/git2/repository.h
+++ b/include/git2/repository.h
@@ -238,7 +238,7 @@ typedef enum {
* repository initialization is completed, an "origin" remote
* will be added pointing to this URL.
*/
-typedef struct git_repository_init_options {
+typedef struct {
uint32_t flags;
uint32_t mode;
const char *workdir_path;
@@ -269,6 +269,10 @@ GIT_EXTERN(int) git_repository_init_ext(
/**
* Retrieve and resolve the reference pointed at by HEAD.
*
+ * The returned `git_reference` will be owned by caller and
+ * `git_reference_free()` must be called when done with it to release the
+ * allocated memory and prevent a leak.
+ *
* @param out pointer to the reference which will be retrieved
* @param repo a repository object
*