Re: [PATCH v2 2/3] environment: clarify repository config getter documentation

Tian Yuchen <[email protected]> writes:

> 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 <[email protected]>
> Mentored-by: Ayush Chandekar <[email protected]>
> Mentored-by: Olamide Caleb Bello <[email protected]>
> Signed-off-by: Tian Yuchen <[email protected]>
> ---
>  environment.h | 14 +++-----------
>  1 file changed, 3 insertions(+), 11 deletions(-)
>
> diff --git a/environment.h b/environment.h
> index e7ec5b0437..1a58b553b5 100644
> --- a/environment.h
> +++ b/environment.h
> @@ -175,22 +175,14 @@ 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 handle repositories that are not fully initialized
> + * by returning appropriate default values.
>   */

Do we also want to mention that calling them when the caller is
outside a repository is an error, or is it obvious enough?

>  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);