Skip to main content

Module magit_refs_mode

Module magit_refs_mode 

Source
Expand description

MG.35: magit-refs-mode — magit’s y show-refs.

Every local branch, remote-tracking branch and tag, grouped, with each branch’s ahead/behind against its upstream. The question it answers is “what refs exist, and where does each point” — which crate::magit_branch_mode does not: that buffer lists local branches so you can act on them, and knows nothing about tags, remote-tracking refs, or how far ahead you are.

<CR> shows the commit, c checks out. Across magit-log, magit-blame, magit-rebase and magit-status’s recent commits, <CR> already means “show the commit detail”; magit-branch-mode’s checkout-on-<CR> is the outlier. Reading is also the safe default here in a way it is not there: <CR> on a tag or a remote-tracking branch under a checkout reading would silently detach HEAD, a state that is hard to recognise and hard to leave, from the most reflexive key in a buffer whose purpose is looking things up.

Structs§

MagitRefsMode
RefsState

Constants§

REFS_VIEW
The view word this mode owns — *magit:refs:<repo>*.

Type Aliases§

RefsStatesHandle
MG.13: service alias for this mode’s per-buffer state — register and look up through this exact type (feedback_servicesregistry_arc_typeid).