]> git.ipfire.org Git - thirdparty/git.git/commitdiff
refs: rename `is_special_ref()` to `is_pseudo_ref()`
authorPatrick Steinhardt <ps@pks.im>
Wed, 15 May 2024 06:50:47 +0000 (08:50 +0200)
committerJunio C Hamano <gitster@pobox.com>
Wed, 15 May 2024 14:30:51 +0000 (07:30 -0700)
Rename `is_special_ref()` to `is_pseudo_ref()` to adapt to the newly
defined terminology in our gitglossary(7). Note that in the preceding
commit we have just renamed `is_pseudoref()` to `is_root_ref()`, where
there may be confusion for in-flight patch series that add new calls to
`is_pseudoref()`. In order to intentionally break such patch series we
have thus picked `is_pseudo_ref()` instead of `is_pseudoref()` as the
new name.

Signed-off-by: Patrick Steinhardt <ps@pks.im>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
refs.c

diff --git a/refs.c b/refs.c
index 434c4da7ce2b38fac83f1d5dad97368aca3275c9..c1c406fc5f6dabf7518269697399fbf862969de7 100644 (file)
--- a/refs.c
+++ b/refs.c
@@ -1872,13 +1872,13 @@ done:
        return result;
 }
 
-static int is_special_ref(const char *refname)
+static int is_pseudo_ref(const char *refname)
 {
        /*
-        * Special references are refs that have different semantics compared
-        * to "normal" refs. These refs can thus not be stored in the ref
-        * backend, but must always be accessed via the filesystem. The
-        * following refs are special:
+        * Pseudorefs are refs that have different semantics compared to
+        * "normal" refs. These refs can thus not be stored in the ref backend,
+        * but must always be accessed via the filesystem. The following refs
+        * are pseudorefs:
         *
         * - FETCH_HEAD may contain multiple object IDs, and each one of them
         *   carries additional metadata like where it came from.
@@ -1887,17 +1887,17 @@ static int is_special_ref(const char *refname)
         *   heads.
         *
         * Reading, writing or deleting references must consistently go either
-        * through the filesystem (special refs) or through the reference
+        * through the filesystem (pseudorefs) or through the reference
         * backend (normal ones).
         */
-       static const char * const special_refs[] = {
+       static const char * const pseudo_refs[] = {
                "FETCH_HEAD",
                "MERGE_HEAD",
        };
        size_t i;
 
-       for (i = 0; i < ARRAY_SIZE(special_refs); i++)
-               if (!strcmp(refname, special_refs[i]))
+       for (i = 0; i < ARRAY_SIZE(pseudo_refs); i++)
+               if (!strcmp(refname, pseudo_refs[i]))
                        return 1;
 
        return 0;
@@ -1908,7 +1908,7 @@ int refs_read_raw_ref(struct ref_store *ref_store, const char *refname,
                      unsigned int *type, int *failure_errno)
 {
        assert(failure_errno);
-       if (is_special_ref(refname))
+       if (is_pseudo_ref(refname))
                return refs_read_special_head(ref_store, refname, oid, referent,
                                              type, failure_errno);