environment: clarify repository config getter documentation

Update the comment above repository config getters to describe their
common behavior.

The getters handle repositories that are not fully initialized by
returning the corresponding default values.

Mentored-by: Christian Couder <christian.couder@gmail.com>
Mentored-by: Ayush Chandekar <ayu.chandekar@gmail.com>
Mentored-by: Olamide Caleb Bello <belkid98@gmail.com>
Signed-off-by: Tian Yuchen <cat@malon.dev>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Tian Yuchen
2026-08-07 16:59:31 +08:00
committed by Junio C Hamano
parent 862564c961
commit a095d70a19

View File

@@ -175,22 +175,15 @@ int git_default_core_config(const char *var, const char *value,
const struct config_context *ctx, void *cb);
/*
* Getters for the `protect_hfs` and `protect_ntfs` fields of `struct repo_config_values`.
* They check `repo->initialized` to prevent calling `repo_config_values()`
* before the repository setup is fully complete or in non-git environments.
* Getters for configuration variables in `struct repo_config_values`.
* These functions require a non-NULL repository pointer and handle
* repositories that are not fully initialized by returning appropriate
* default values.
*/
int repo_protect_hfs(struct repository *repo);
int repo_protect_ntfs(struct repository *repo);
/*
* Getter for the `ignore_case` field of `struct repo_config_values`.
* It checks `repo->initialized` to prevent calling repo_config_values()`
* before the repository setup is fully complete or in non-git environments.
*/
int repo_ignore_case(struct repository *repo);
int repo_trust_executable_bit(struct repository *repo);
int repo_has_symlinks(struct repository *repo);
const char *repo_excludes_file(struct repository *repo);