development/git
development/git
1
0
Fork 0
mirror of https://github.com/git/git synced 2024-07-05 00:58:49 +00:00
Code Issues Projects Releases Wiki Activity

Documentation/glossary: clarify limitations of pseudorefs

Browse Source 
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>
This commit is contained in:
Patrick Steinhardt 2024-05-15 08:50:33 +02:00 committed by Junio C Hamano
parent 6fd8037564
commit 29be36a2ea
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/glossary-content.txt
View File

@ -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: