refs: classify HEAD as a root ref

Root refs are those refs that live in the root of the ref hierarchy. Our old and venerable "HEAD" reference falls into this category, but we don't yet classify it as such in `is_root_ref()`. Adapt the function to also treat "HEAD" as a root ref. This change is safe to do for all current callers: - `ref_kind_from_refname()` already handles "HEAD" explicitly before calling `is_root_ref()`. - The "files" and "reftable" backends explicitly call both `is_root_ref()` and `is_headref()` together. This also aligns behaviour or `is_root_ref()` and `is_headref()` such that we stop checking for ref existence. This changes semantics for our backends: - In the reftable backend we already know that the ref must exist because `is_headref()` is called as part of the ref iterator. The existence check is thus redundant, and the change is safe to do. - In the files backend we use it when populating root refs, where we would skip adding the "HEAD" file if it was not possible to resolve it. The new behaviour is to instead mark "HEAD" as broken, which will cause us to emit warnings in various places. As there are no callers of `is_headref()` left afer the refactoring, we can absorb it completely into `is_root_ref()`. Signed-off-by: Patrick Steinhardt <ps@pks.im> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Patrick Steinhardt committed May 15, 2024 at 08:50 UTC 31951c22489dc4238ef881478a896a460531b722
4 files changed +5 -15
refs.c
+1 -8
@@ -859,6 +859,7 @@ static int is_root_ref_syntax(const char *refname)
859 int is_root_ref(const char *refname)
860 {
861 static const char *const irregular_root_refs[] = {
862 + "HEAD",
863 "AUTO_MERGE",
864 "BISECT_EXPECTED_REV",
865 "NOTES_MERGE_PARTIAL",
@@ -880,14 +881,6 @@ int is_root_ref(const char *refname)
881 return 0;
882 }
883
883 -int is_headref(struct ref_store *refs, const char *refname)
884 -{
885 - if (!strcmp(refname, "HEAD"))
886 - return refs_ref_exists(refs, refname);
887 -
888 - return 0;
889 -}
890 -
884 static int is_current_worktree_ref(const char *ref) {
885 return is_root_ref_syntax(ref) || is_per_worktree_ref(ref);
886 }
refs.h
+2 -3
@@ -1060,7 +1060,8 @@ void update_ref_namespace(enum ref_namespace namespace, char *ref);
1060 *
1061 * - Their name must be all-uppercase or underscores ("_").
1062 *
1063 - * - Their name must end with "_HEAD".
1063 + * - Their name must end with "_HEAD". As a special rule, "HEAD" is a root
1064 + * ref, as well.
1065 *
1066 * - Their name may not contain a slash.
1067 *
@@ -1079,6 +1080,4 @@ void update_ref_namespace(enum ref_namespace namespace, char *ref);
1080 */
1081 int is_root_ref(const char *refname);
1082
1082 -int is_headref(struct ref_store *refs, const char *refname);
1083 -
1083 #endif /* REFS_H */
refs/files-backend.c
+1 -2
@@ -351,8 +351,7 @@ static void add_pseudoref_and_head_entries(struct ref_store *ref_store,
351 strbuf_addstr(&refname, de->d_name);
352
353 dtype = get_dtype(de, &path, 1);
354 - if (dtype == DT_REG && (is_root_ref(de->d_name) ||
355 - is_headref(ref_store, de->d_name)))
354 + if (dtype == DT_REG && is_root_ref(de->d_name))
355 loose_fill_ref_dir_regular_file(refs, refname.buf, dir);
356
357 strbuf_setlen(&refname, dirnamelen);
refs/reftable-backend.c
+1 -2
@@ -356,8 +356,7 @@ static int reftable_ref_iterator_advance(struct ref_iterator *ref_iterator)
356 */
357 if (!starts_with(iter->ref.refname, "refs/") &&
358 !(iter->flags & DO_FOR_EACH_INCLUDE_ROOT_REFS &&
359 - (is_root_ref(iter->ref.refname) ||
360 - is_headref(&iter->refs->base, iter->ref.refname)))) {
359 + is_root_ref(iter->ref.refname))) {
360 continue;
361 }
362