proxmox-mirrors/libgit2
1
0
Fork 0
mirror of https://git.proxmox.com/git/libgit2 synced 2025-05-29 17:05:49 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

config: correct documentation for non-existent config file

Browse Source
This commit is contained in:
Carlos Martín Nieto 2015-09-03 11:38:21 +02:00
parent 21e7015ca3
commit 1cef6b9f19
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
include/git2/config.h
View File

@ -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 * parsed; it's expected to be a native Git config file following
* the default Git config syntax (see man git-config). * 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 * Note that the configuration object will free the file
* automatically. * automatically.
* *
@ -202,8 +205,7 @@ GIT_EXTERN(int) git_config_add_file_ondisk(
* *
* @param out The configuration instance to create * @param out The configuration instance to create
* @param path Path to the on-disk file to open * @param path Path to the on-disk file to open
* @return 0 on success, GIT_ENOTFOUND when the file doesn't exist * @return 0 on success, or an error code
* or an error code
*/ */
GIT_EXTERN(int) git_config_open_ondisk(git_config **out, const char *path); GIT_EXTERN(int) git_config_open_ondisk(git_config **out, const char *path);