Re: [PATCH v2 2/3] environment: clarify repository config getter documentation
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Aug 6, 2026, 16:54 UTC
- Message-ID
- <xmqqpkzvkx54.fsf@gitster.g>
- In-Reply-To
- <20260806092557.3951208-3-cat@malon.dev>
Tian Yuchen <cat@malon.dev> writes:
Show 29 quoted lines
> 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> > --- > 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?
Show 15 quoted lines
> 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);