Documentation: add "special refs" to the glossary
Add the "special refs" term to our glossary. Signed-off-by: Patrick Steinhardt <ps@pks.im> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Patrick Steinhardt committed
Jan 19, 2024 at 11:40 UTC
8df4c5d205263c98378f0eea2b4ebab5e5c174aa
1 file changed
+14
Documentation/glossary-content.txt
+14
@@ -638,6 +638,20 @@ The most notable example is `HEAD`.
638
An <<def_object,object>> used to temporarily store the contents of a
639
<<def_dirty,dirty>> working directory and the index for future reuse.
640
641
+[[def_special_ref]]special ref::
642
+ A ref that has different semantics than normal refs. These refs can be
643
+ accessed via normal Git commands but may not behave the same as a
644
+ normal ref in some cases.
645
++
646
+The following special refs are known to Git:
647
+
648
+ - "`FETCH_HEAD`" is written by linkgit:git-fetch[1] or linkgit:git-pull[1]. It
649
+ may refer to multiple object IDs. Each object ID is annotated with metadata
650
+ indicating where it was fetched from and its fetch status.
651
+
652
+ - "`MERGE_HEAD`" is written by linkgit:git-merge[1] when resolving merge
653
+ conflicts. It contains all commit IDs which are being merged.
654
+
655
[[def_submodule]]submodule::
656
A <<def_repository,repository>> that holds the history of a
657
separate project inside another repository (the latter of