[PATCH v2 2/5] doc: glossary: update per-worktree refs
- From
Andy Koppe <andy.koppe@gmail.com>
- Date
- Nov 1, 2026, 23:03 UTC
- Message-ID
- <20261101230326.3675597-3-andy.koppe@gmail.com>
- In-Reply-To
- <20261022212903.177261-1-andy.koppe@gmail.com>
The "per-worktree ref" entry says that these are only HEAD and refs under "refs/bisect/", but that has been out of date since a9be29c981 (sequencer: make refs generated by the `label` command worktree-local, 2018-04-25). All root refs are per-worktree, as are refs under "refs/worktree/" and "refs/rewritten/". Pseudorefs are specific to each worktree too.
Bring the list up to date, and refer to git-worktree(1) for how to access per-worktree refs of other worktrees. In the "worktree" entry, describe HEAD as a per-worktree ref and MERGE_HEAD as a pseudoref, rather than listing them separately from per-worktree refs.
Signed-off-by: Andy Koppe <andy.koppe@gmail.com> --- Documentation/glossary-content.adoc | 25 +++++++++++++++++++------ 1 file changed, 19 insertions(+), 6 deletions(-)
diff --git a/Documentation/glossary-content.adoc b/Documentation/glossary-content.adoc index f905b4467b..67fe49b26d 100644 --- a/Documentation/glossary-content.adoc +++ b/Documentation/glossary-content.adoc @@ -494,10 +494,23 @@ exclude;; interface than the <<def_plumbing,plumbing>>. [[def_per_worktree_ref]]per-worktree ref:: - Refs that are per-<<def_worktree,worktree>>, rather than - global. This is presently only <<def_HEAD,HEAD>> and any refs - that start with `refs/bisect/`, but might later include other - unusual refs. + A <<def_ref,ref>> that is specific to a <<def_worktree,worktree>>, + rather than shared between all worktrees. All <<def_root_ref,root refs>>, + for example <<def_HEAD,HEAD>> and `ORIG_HEAD`, are per-worktree, as are + refs with the following prefixes: ++ +-- + - `refs/bisect/` + + - `refs/rewritten/` + + - `refs/worktree/` +-- ++ +<<def_pseudoref,Pseudorefs>> are also specific to each worktree. ++ +See "REFS" in linkgit:git-worktree[1] for how to access the +per-worktree refs of other worktrees. [[def_pseudoref]]pseudoref:: A name that can be used like a <<def_ref,ref>> to refer to an @@ -791,5 +804,5 @@ and pseudorefs. "working tree" and repository metadata, most of which are shared among other worktrees of a single repository, and some of which are maintained separately per worktree - (e.g. the index, HEAD and pseudorefs like MERGE_HEAD, - per-worktree refs and per-worktree configuration file). + (e.g. the index, <<def_per_worktree_ref,per-worktree refs>>, and the + per-worktree configuration file).
-- 2.56.0