| Message ID | 1f2f8cf3f2cfba65787551ce6571376275ef3a8d.1714479928.git.ps@pks.im (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | Clarify pseudo-ref terminology | expand |
On Tue, Apr 30, 2024, at 14:26, Patrick Steinhardt wrote: > - They are not surfaced when iterating through refs, like when using > git-for-each-ref(1). They are no ref, so iterating through refs > should not surface them. s/They are no ref/They are not refs
diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt index f5c0f49150..13e1aa63ab 100644 --- a/Documentation/glossary-content.txt +++ b/Documentation/glossary-content.txt @@ -498,8 +498,8 @@ exclude;; [[def_pseudoref]]pseudoref ref:: 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:
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 no ref, 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> --- Documentation/glossary-content.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)