Git development
 help / color / mirror / Atom feed
From: Tian Yuchen <cat@malon.dev>
To: git@vger.kernel.org
Cc: Tian Yuchen <cat@malon.dev>,
	Christian Couder <christian.couder@gmail.com>,
	Ayush Chandekar <ayu.chandekar@gmail.com>,
	Olamide Caleb Bello <belkid98@gmail.com>
Subject: [PATCH v3 2/3] environment: clarify repository config getter documentation
Date: Fri,  7 Aug 2026 16:59:31 +0800	[thread overview]
Message-ID: <20260807085932.3958759-3-cat@malon.dev> (raw)
In-Reply-To: <20260807085932.3958759-1-cat@malon.dev>

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 | 15 ++++-----------
 1 file changed, 4 insertions(+), 11 deletions(-)

diff --git a/environment.h b/environment.h
index e7ec5b0437..6f864c1635 100644
--- a/environment.h
+++ b/environment.h
@@ -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);
-- 
2.43.0


  parent reply	other threads:[~2026-08-07  8:59 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-08-05 11:53 [PATCH 0/3] environment: clean up repository config handling Tian Yuchen
2026-08-05 11:53 ` [PATCH 1/3] environment: simplify repository config getters Tian Yuchen
2026-08-05 21:49   ` Junio C Hamano
2026-08-05 11:53 ` [PATCH 2/3] environment: clarify repository config getter documentation Tian Yuchen
2026-08-05 21:38   ` Junio C Hamano
2026-08-06  8:49     ` Tian Yuchen
2026-08-05 11:53 ` [PATCH 3/3] environment: reorder variables in repo_config_values structure Tian Yuchen
2026-08-05 21:47   ` Junio C Hamano
2026-08-06  8:44     ` Tian Yuchen
2026-08-06 16:42       ` Junio C Hamano
2026-08-07  8:26         ` Tian Yuchen
2026-08-06  9:25 ` [PATCH v2 0/3] environment: clean up repository config handling Tian Yuchen
2026-08-06  9:25   ` [PATCH v2 1/3] environment: simplify repository config getters Tian Yuchen
2026-08-06 16:50     ` Junio C Hamano
2026-08-07  8:30       ` Tian Yuchen
2026-08-06  9:25   ` [PATCH v2 2/3] environment: clarify repository config getter documentation Tian Yuchen
2026-08-06 16:54     ` Junio C Hamano
2026-08-06  9:25   ` [PATCH v2 3/3] environment: remove inaccurate repo_config_values comments Tian Yuchen
2026-08-07  8:59 ` [PATCH v3 0/3] environment: clean up repository config handling Tian Yuchen
2026-08-07  8:59   ` [PATCH v3 1/3] environment: drop redundant NULL checks in config getters Tian Yuchen
2026-08-07  8:59   ` Tian Yuchen [this message]
2026-08-07  8:59   ` [PATCH v3 3/3] environment: remove inaccurate repo_config_values comments Tian Yuchen
2026-08-07 11:04   ` [PATCH v3 0/3] environment: clean up repository config handling Patrick Steinhardt
2026-08-07 21:11     ` Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260807085932.3958759-3-cat@malon.dev \
    --to=cat@malon.dev \
    --cc=ayu.chandekar@gmail.com \
    --cc=belkid98@gmail.com \
    --cc=christian.couder@gmail.com \
    --cc=git@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox