summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCarlos Martín Nieto <cmn@dwim.me>2015-09-03 11:38:21 +0200
committerCarlos Martín Nieto <cmn@dwim.me>2015-09-03 11:39:17 +0200
commitbad51c5195e14b5e1e9f54a9c400e8b89f4dd446 (patch)
treea8c9f2538fa5edd05cd2863826d21365d8ba099c
parentac1c15756ba36270e253de13e3fcf1ddbc43ae1b (diff)
downloadlibgit2-update-v23.tar.gz
config: correct documentation for non-existent config fileupdate-v23
-rw-r--r--include/git2/config.h6
1 files changed, 4 insertions, 2 deletions
diff --git a/include/git2/config.h b/include/git2/config.h
index 6d3fdb0c2..537663ec9 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);