mirror/git
1
0
Fork 0
mirror of https://github.com/git/git.git synced 2024-10-18 12:18:44 +02:00
Code

config: document read_early_config() and read_very_early_config()

Browse Source 
It's not clear what `read_early_config()` and `read_very_early_config()`
do differently compared to `repo_read_config()` from just looking at
their names. Document both of these in the header file to clarify their
intent.

Signed-off-by: Patrick Steinhardt <ps@pks.im>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Patrick Steinhardt 2024-09-12 13:29:43 +02:00 committed by Junio C Hamano
parent edc2c92624
commit c0b03e8b6d
2 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
config.c
View File

@ -2234,10 +2234,6 @@ void read_early_config(config_fn_t cb, void *data)
strbuf_release(&gitdir);
}
/*
* Read config but only enumerate system and global settings.
* Omit any repo-local, worktree-local, or command-line settings.
*/
void read_very_early_config(config_fn_t cb, void *data)
{
struct config_options opts = { 0 };

11
config.h
View File

@ -192,7 +192,18 @@ int git_config_from_blob_oid(config_fn_t fn, const char *name,
void git_config_push_parameter(const char *text);
void git_config_push_env(const char *spec);
int git_config_from_parameters(config_fn_t fn, void *data);
/*
* Read config when the Git directory has not yet been set up. In case
* `the_repository` has not yet been set up, try to discover the Git
* directory to read the configuration from.
*/
void read_early_config(config_fn_t cb, void *data);
/*
* Read config but only enumerate system and global settings.
* Omit any repo-local, worktree-local, or command-line settings.
*/
void read_very_early_config(config_fn_t cb, void *data);
/**