Documentation/glossary: clarify limitations of pseudorefs
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> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Patrick Steinhardt committed
May 15, 2024 at 08:50 UTC
29be36a2ea4a7d681f8318090a22b937756b89d0
1 file changed
+2
-2
Documentation/glossary-content.txt
+2
-2
@@ -498,8 +498,8 @@ exclude;;
498
499
[[def_pseudoref]]pseudoref::
500
A ref that has different semantics than normal refs. These refs can be
501
- accessed via normal Git commands but may not behave the same as a
502
- normal ref in some cases.
501
+ read via normal Git commands, but cannot be written to by commands like
502
+ linkgit:git-update-ref[1].
503
+
504
The following pseudorefs are known to Git:
505