diff options
Diffstat (limited to 'include/git2/repository.h')
| -rw-r--r-- | include/git2/repository.h | 6 |
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 |