git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v5 05/10] refs: rename `is_special_ref()` to `is_pseudo_ref()`

From
Patrick Steinhardt <ps@pks.im>
Date
May 15, 2024, 06:50 UTC
Message-ID
<9087696d8206c9a099463c27c9274b7bab2b86dc.1715755591.git.ps@pks.im>
In-Reply-To
<cover.1715755591.git.ps@pks.im>

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>
---
 refs.c | 20 ++++++++++----------
 1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/refs.c b/refs.c
index 434c4da7ce..c1c406fc5f 100644
--- a/refs.c
+++ b/refs.c
@@ -1872,13 +1872,13 @@ static int refs_read_special_head(struct ref_store *ref_store,
 	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);
 
-- 
2.45.GIT
Previous: Patrick SteinhardtNext: Patrick Steinhardt
Message 85 of 93 in “Clarify pseudo-ref terminology”
  1. 0/3 Clarify pseudo-ref terminologyPatrick Steinhardt, Apr 29, 2024
  2. 1/3 refs: move `is_special_ref()`Patrick Steinhardt, Apr 29, 2024
  3. 2/3 refs: do not label special refs as pseudo refsPatrick Steinhardt, Apr 29, 2024
  4. Phillip WoodApr 29, 2024
  5. Patrick SteinhardtApr 30, 2024
  6. Phillip WoodApr 30, 2024
  7. Patrick SteinhardtApr 30, 2024
  8. Jeff KingApr 30, 2024
  9. Karthik NayakApr 30, 2024
  10. Patrick SteinhardtApr 30, 2024
  11. Patrick SteinhardtApr 30, 2024
  12. Junio C HamanoApr 29, 2024
  13. Justin ToblerApr 29, 2024
  14. Patrick SteinhardtApr 30, 2024
  15. Jean-Noël AVILAMay 9, 2024
  16. Patrick SteinhardtMay 10, 2024
  17. 3/3 refs: fix segfault in `is_pseudoref()` when ref cannot be resolvedPatrick Steinhardt, Apr 29, 2024
  18. Phillip WoodApr 29, 2024
  19. Karthik NayakApr 29, 2024
  20. Phillip WoodApr 29, 2024
  21. Karthik NayakApr 29, 2024
  22. Patrick SteinhardtApr 30, 2024
  23. 00/10 Clarify pseudo-ref terminologyPatrick Steinhardt, Apr 30, 2024
  24. 01/10 Documentation/glossary: redefine pseudorefs as special refsPatrick Steinhardt, Apr 30, 2024
  25. Karthik NayakApr 30, 2024
  26. Justin ToblerApr 30, 2024
  27. Junio C HamanoApr 30, 2024
  28. Patrick SteinhardtMay 2, 2024
  29. 02/10 Documentation/glossary: clarify limitations of pseudorefsPatrick Steinhardt, Apr 30, 2024
  30. Kristoffer HaugsbakkApr 30, 2024
  31. 03/10 Documentation/glossary: define root refs as refsPatrick Steinhardt, Apr 30, 2024
  32. Karthik NayakApr 30, 2024
  33. 04/10 refs: rename `is_pseudoref()` to `is_root_ref()`Patrick Steinhardt, Apr 30, 2024
  34. Junio C HamanoApr 30, 2024
  35. 05/10 refs: refname `is_special_ref()` to `is_pseudo_ref()`Patrick Steinhardt, Apr 30, 2024
  36. Karthik NayakApr 30, 2024
  37. 06/10 refs: classify HEAD as a root refPatrick Steinhardt, Apr 30, 2024
  38. 07/10 refs: root refs can be symbolic refsPatrick Steinhardt, Apr 30, 2024
  39. Justin ToblerApr 30, 2024
  40. Patrick SteinhardtMay 2, 2024
  41. Justin ToblerMay 3, 2024
  42. Patrick SteinhardtMay 7, 2024
  43. 08/10 refs: pseudorefs are no refsPatrick Steinhardt, Apr 30, 2024
  44. 09/10 ref-filter: properly distinuish pseudo and root refsPatrick Steinhardt, Apr 30, 2024
  45. Karthik NayakApr 30, 2024
  46. Patrick SteinhardtMay 2, 2024
  47. Karthik NayakMay 2, 2024
  48. 10/10 refs: refuse to write pseudorefsPatrick Steinhardt, Apr 30, 2024
  49. 00/10 Clarify pseudo-ref terminologyPatrick Steinhardt, May 2, 2024
  50. 01/10 Documentation/glossary: redefine pseudorefs as special refsPatrick Steinhardt, May 2, 2024
  51. 02/10 Documentation/glossary: clarify limitations of pseudorefsPatrick Steinhardt, May 2, 2024
  52. 03/10 Documentation/glossary: define root refs as refsPatrick Steinhardt, May 2, 2024
  53. 04/10 refs: rename `is_pseudoref()` to `is_root_ref()`Patrick Steinhardt, May 2, 2024
  54. 05/10 refs: refname `is_special_ref()` to `is_pseudo_ref()`Patrick Steinhardt, May 2, 2024
  55. 06/10 refs: classify HEAD as a root refPatrick Steinhardt, May 2, 2024
  56. 07/10 refs: root refs can be symbolic refsPatrick Steinhardt, May 2, 2024
  57. Jeff KingMay 3, 2024
  58. Patrick SteinhardtMay 15, 2024
  59. Patrick SteinhardtMay 15, 2024
  60. Jeff KingMay 15, 2024
  61. Patrick SteinhardtMay 15, 2024
  62. Jeff KingMay 15, 2024
  63. Patrick SteinhardtMay 15, 2024
  64. Jeff KingMay 15, 2024
  65. 08/10 refs: pseudorefs are no refsPatrick Steinhardt, May 2, 2024
  66. 09/10 ref-filter: properly distinuish pseudo and root refsPatrick Steinhardt, May 2, 2024
  67. 10/10 refs: refuse to write pseudorefsPatrick Steinhardt, May 2, 2024
  68. 00/10 Clarify pseudo-ref terminologyPatrick Steinhardt, May 10, 2024
  69. 01/10 Documentation/glossary: redefine pseudorefs as special refsPatrick Steinhardt, May 10, 2024
  70. 02/10 Documentation/glossary: clarify limitations of pseudorefsPatrick Steinhardt, May 10, 2024
  71. 03/10 Documentation/glossary: define root refs as refsPatrick Steinhardt, May 10, 2024
  72. 04/10 refs: rename `is_pseudoref()` to `is_root_ref()`Patrick Steinhardt, May 10, 2024
  73. 05/10 refs: refname `is_special_ref()` to `is_pseudo_ref()`Patrick Steinhardt, May 10, 2024
  74. 06/10 refs: root refs can be symbolic refsPatrick Steinhardt, May 10, 2024
  75. 07/10 refs: classify HEAD as a root refPatrick Steinhardt, May 10, 2024
  76. 08/10 refs: pseudorefs are no refsPatrick Steinhardt, May 10, 2024
  77. 09/10 ref-filter: properly distinuish pseudo and root refsPatrick Steinhardt, May 10, 2024
  78. 10/10 refs: refuse to write pseudorefsPatrick Steinhardt, May 10, 2024
  79. Junio C HamanoMay 10, 2024
  80. 00/10 Clarify pseudo-ref terminologyPatrick Steinhardt, May 15, 2024
  81. 01/10 Documentation/glossary: redefine pseudorefs as special refsPatrick Steinhardt, May 15, 2024
  82. 02/10 Documentation/glossary: clarify limitations of pseudorefsPatrick Steinhardt, May 15, 2024
  83. 03/10 Documentation/glossary: define root refs as refsPatrick Steinhardt, May 15, 2024
  84. 04/10 refs: rename `is_pseudoref()` to `is_root_ref()`Patrick Steinhardt, May 15, 2024
  85. 05/10 refs: rename `is_special_ref()` to `is_pseudo_ref()`Patrick Steinhardt, May 15, 2024
  86. 06/10 refs: do not check ref existence in `is_root_ref()`Patrick Steinhardt, May 15, 2024
  87. Justin ToblerMay 15, 2024
  88. Patrick SteinhardtMay 16, 2024
  89. 07/10 refs: classify HEAD as a root refPatrick Steinhardt, May 15, 2024
  90. Justin ToblerMay 15, 2024
  91. 08/10 refs: pseudorefs are no refsPatrick Steinhardt, May 15, 2024
  92. 09/10 ref-filter: properly distinuish pseudo and root refsPatrick Steinhardt, May 15, 2024
  93. 10/10 refs: refuse to write pseudorefsPatrick Steinhardt, May 15, 2024

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.