config: correct documentation for non-existent config file

carlosmn · carlosmn · commit bad51c5195e1 · 2015-09-03T11:39:17.000+02:00
diff --git 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);
 

Original file line number	Diff line number	Diff line change
`@@ -171,6 +171,9 @@ GIT_EXTERN(int) git_config_new(git_config **out);`
`171`	`171`	`* parsed; it's expected to be a native Git config file following`
`172`	`172`	`* the default Git config syntax (see man git-config).`
`173`	`173`	`*`
	`174`	`+ * If the file does not exist, the file will still be added and it`
	`175`	`+ * will be created the first time we write to it.`
	`176`	`+ *`
`174`	`177`	`* Note that the configuration object will free the file`
`175`	`178`	`* automatically.`
`176`	`179`	`*`
`@@ -202,8 +205,7 @@ GIT_EXTERN(int) git_config_add_file_ondisk(`
`202`	`205`	`*`
`203`	`206`	`* @param out The configuration instance to create`
`204`	`207`	`* @param path Path to the on-disk file to open`
`205`		`- * @return 0 on success, GIT_ENOTFOUND when the file doesn't exist`
`206`		`- * or an error code`
	`208`	`+ * @return 0 on success, or an error code`
`207`	`209`	`*/`
`208`	`210`	`GIT_EXTERN(int) git_config_open_ondisk(git_config *out, const char path);`
`209`	`211`