diff options
author | Carlos Martín Nieto <cmn@dwim.me> | 2015-09-03 11:38:21 +0200 |
---|---|---|
committer | Carlos Martín Nieto <cmn@dwim.me> | 2015-09-03 11:38:21 +0200 |
commit | 1cef6b9f190587a78c65bd3168879be3eb37e0fb (patch) | |
tree | 07d73e76110821f0115e1e43495f23bbdddc896e | |
parent | 21e7015ca3425e396c2b7cc03ac67e297a646c91 (diff) | |
download | libgit2-1cef6b9f190587a78c65bd3168879be3eb37e0fb.tar.gz |
config: correct documentation for non-existent config file
-rw-r--r-- | include/git2/config.h | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/include/git2/config.h b/include/git2/config.h index 05c3ad622..56b5431ac 100644 --- a/include/git2/config.h +++ b/include/git2/config.h @@ -171,6 +171,9 @@ GIT_EXTERN(int) git_config_new(git_config **out); * parsed; it's expected to be a native Git config file following * the default Git config syntax (see man git-config). * + * If the file does not exist, the file will still be added and it + * will be created the first time we write to it. + * * Note that the configuration object will free the file * automatically. * @@ -202,8 +205,7 @@ GIT_EXTERN(int) git_config_add_file_ondisk( * * @param out The configuration instance to create * @param path Path to the on-disk file to open - * @return 0 on success, GIT_ENOTFOUND when the file doesn't exist - * or an error code + * @return 0 on success, or an error code */ GIT_EXTERN(int) git_config_open_ondisk(git_config **out, const char *path); |