Skip to content

Commit 29be36a

Browse files
pks-tgitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 6fd8037 commit 29be36a

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

Documentation/glossary-content.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -498,8 +498,8 @@ exclude;;
498498

499499
[[def_pseudoref]]pseudoref::
500500
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].
503503
+
504504
The following pseudorefs are known to Git:
505505

0 commit comments

Comments
 (0)