diff options
| author | Patrick Steinhardt <ps@pks.im> | 2024-05-15 08:50:33 +0200 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2024-05-15 07:30:51 -0700 |
| commit | 29be36a2ea4a7d681f8318090a22b937756b89d0 (patch) | |
| tree | 83a548395050e9ec30293ad6e7cc4f5977d6e071 | |
| parent | Documentation/glossary: redefine pseudorefs as special refs (diff) | |
| download | git-29be36a2ea4a7d681f8318090a22b937756b89d0.tar.gz git-29be36a2ea4a7d681f8318090a22b937756b89d0.zip | |
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>
| -rw-r--r-- | Documentation/glossary-content.txt | 4 |
1 files changed, 2 insertions, 2 deletions
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: |