From: Patrick Steinhardt Date: Wed, 15 May 2024 06:50:33 +0000 (+0200) Subject: Documentation/glossary: clarify limitations of pseudorefs X-Git-Tag: v2.46.0-rc0~104^2~8 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=29be36a2ea4a7d681f8318090a22b937756b89d0;p=thirdparty%2Fgit.git 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 Signed-off-by: Junio C Hamano --- 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: