summaryrefslogtreecommitdiff
path: root/include/git2
diff options
context:
space:
mode:
authorRussell Belfer <rb@github.com>2014-05-12 10:24:46 -0700
committerRussell Belfer <rb@github.com>2014-05-12 10:24:46 -0700
commitb1914c36511af468366482c4dc8974bd1c2995fc (patch)
treee91760de0d340b9702ca8d4070eed33eb66d0874 /include/git2
parent7bcced44b7e5536ab1a92ad37735566e855531d0 (diff)
downloadlibgit2-b1914c36511af468366482c4dc8974bd1c2995fc.tar.gz
Minor fixes for warnings and error propagation
Diffstat (limited to 'include/git2')
-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 0f7119b76..037cb3f96 100644
--- a/include/git2/repository.h
+++ b/include/git2/repository.h
@@ -418,7 +418,11 @@ GIT_EXTERN(int) git_repository_config(git_config **out, git_repository *repo);
* Get a snapshot of the repository's configuration
*
* Convenience function to take a snapshot from the repository's
- * configuration.
+ * configuration. The contents of this snapshot will not change,
+ * even if the underlying config files are modified.
+ *
+ * The configuration file must be freed once it's no longer
+ * being used by the user.
*
* @param out Pointer to store the loaded configuration
* @param repo the repository