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

config: explain the cfg and file relationship better

Browse Source 
It's not clear how git_config and git_config_file relate to one
another. Be more explicit about their relationship in the function
documentation.

Signed-off-by: Carlos Martín Nieto <cmn@elego.de>
This commit is contained in:
Carlos Martín Nieto 2011-06-07 15:39:40 +02:00
parent ce78f39e27
commit a2a305fcf4
1 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
include/git2/config.h
View File

@ -56,7 +56,9 @@ struct git_config_file {
* Create a configuration file backend for ondisk files * Create a configuration file backend for ondisk files
* *
* These are the normal `.gitconfig` files that Core Git * These are the normal `.gitconfig` files that Core Git
* processes. * processes. Note that you first have to add this file to a
* configuration object before you can query it for configuration
* variables.
* *
* @param out the new backend * @param out the new backend
* @path where the config file is located * @path where the config file is located
@ -64,13 +66,21 @@ struct git_config_file {
GIT_EXTERN(int) git_config_file__ondisk(struct git_config_file **out, const char *path); GIT_EXTERN(int) git_config_file__ondisk(struct git_config_file **out, const char *path);
/** /**
* Allocate a new configuration * Allocate a new configuration object
*
* This object is empty, so you have to add a file to it before you
* can do anything with it.
*
* @param out pointer to the new configuration
*/ */
GIT_EXTERN(int) git_config_new(git_config **out); GIT_EXTERN(int) git_config_new(git_config **out);
/** /**
* Open a configuration file * Open a configuration file
* *
* This creates a new configuration object and adds the specified file
* to it.
*
* @param cfg_out pointer to the configuration data * @param cfg_out pointer to the configuration data
* @param path where to load the confiration from * @param path where to load the confiration from
*/ */
@ -86,17 +96,17 @@ GIT_EXTERN(int) git_config_open_global(git_config **cfg);
/** /**
* Add a config backend to an existing instance * Add a config backend to an existing instance
* *
* Note that the configuration will call the backend's ->free() * Note that the configuration object will free the file
* function. * automatically.
* *
* @param cfg the configuration to add the file to * @param cfg the configuration to add the file to
* @param file the configuration source (file) to add * @param file the configuration file (backend) to add
* @param priority the priority the backend should have * @param priority the priority the backend should have
*/ */
GIT_EXTERN(int) git_config_add_file(git_config *cfg, git_config_file *file, int priority); GIT_EXTERN(int) git_config_add_file(git_config *cfg, git_config_file *file, int priority);
/** /**
* Free the configuration and its associated memory * Free the configuration and its associated memory and files
* *
* @param cfg the configuration to free * @param cfg the configuration to free
*/ */