diff mbox series

[v5,02/10] Documentation/glossary: clarify limitations of pseudorefs

Message ID d328081c528e73f6fc179d386d829f130bf46a6c.1715755591.git.ps@pks.im (mailing list archive)
State Accepted
Commit 29be36a2ea4a7d681f8318090a22b937756b89d0
Headers show
Series Clarify pseudo-ref terminology | expand

Commit Message

Patrick Steinhardt May 15, 2024, 6:50 a.m. UTC 
Clarify limitations that pseudorefs have:

  - They can be read via git-rev-parse(1) and similar tools.

  - They are not surfaced when iterating through refs, like when using
    git-for-each-ref(1). They are not refs, so iterating through refs
    should not surface them.

  - They cannot be written via git-update-ref(1) and related commands.

Signed-off-by: Patrick Steinhardt <ps@pks.im>
---
 Documentation/glossary-content.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
diff mbox series

Patch

diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt
index e686c83026..d8c04b37be 100644
--- a/Documentation/glossary-content.txt
+++ b/Documentation/glossary-content.txt
@@ -498,8 +498,8 @@  exclude;;
 
 [[def_pseudoref]]pseudoref::
 	A ref that has different semantics than normal refs. These refs can be
-	accessed via normal Git commands but may not behave the same as a
-	normal ref in some cases.
+	read via normal Git commands, but cannot be written to by commands like
+	linkgit:git-update-ref[1].
 +
 The following pseudorefs are known to Git: