Skip to main content

Module magit_notes_mode

Module magit_notes_mode 

Source
Expand description

MG.37: magit-notes-mode — the note attached to one commit, as an editable buffer.

*magit:note:<sha>*, seeded with git notes show <sha> (empty when there is none). C-c C-c writes it, C-c C-k closes without writing — the same pair crate::magit_commit_mode uses, and for the same reason: this is a compose buffer, not a view.

This buffer exists because git notes edit opens $EDITOR. Inside an editor that means a child waiting on a terminal that is not there — it would hang holding a blocking-pool thread and never report. lattice_vcs::Note::set pipes the text to -F - instead, which makes this buffer the editor.

Notes need no separate viewer: git show prints them by default, so crate::magit_revision_mode already displays a commit’s note under its message. Pinned by a test in lattice-vcs, because a future --no-notes would silently remove the only place they surface.

Structs§

MagitNotesMode
NoteState

Type Aliases§

NoteStatesHandle
MG.13: service alias for this mode’s per-buffer state (feedback_servicesregistry_arc_typeid).