diff options
| author | Patrick Steinhardt <ps@pks.im> | 2024-05-02 10:17:18 +0200 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2024-05-02 09:43:56 -0700 |
| commit | 2b641cabe751881d383e16fb5e0e0cd2a0dfa153 (patch) | |
| tree | 20f8c182c9b8ebebac18bc04d72b38d8228d8895 | |
| parent | 941b78198e19204cff0e335241a022dcba1795b7 (diff) | |
| download | git-2b641cabe751881d383e16fb5e0e0cd2a0dfa153.tar.gz | |
Documentation/glossary: clarify limitations of pseudorefs
Notice: this object is not reachable from any branch.
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>
Notice: this object is not reachable from any branch.
| -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 ca04768e3b..b464b926d5 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: |