8.2 Notes

Also see the git-notes(1) manpage.

T     (magit-notes-popup)

This prefix command shows the following suffix commands along with the appropriate infix arguments in a popup buffer.

T T     (magit-notes-edit)

Edit the note attached to a commit, defaulting to the commit at point.

By default use the value of Git variable core.notesRef or "refs/notes/commits" if that is undefined.

T r     (magit-notes-remove)

Remove the note attached to a commit, defaulting to the commit at point.

By default use the value of Git variable core.notesRef or "refs/notes/commits" if that is undefined.

T p     (magit-notes-prune)

Remove notes about unreachable commits.

T s     (magit-notes-set-ref)

Set the current notes ref to a the value read from the user. The ref is made current by setting the value of the Git variable core.notesRef. With a prefix argument change the global value instead of the value in the current repository. When this is undefined, then "refs/notes/commit" is used.

Other magit-notes-* commands, as well as the sub-commands of Git’s note command, default to operate on that ref.

T S     (magit-notes-set-display-refs)

Set notes refs to be display in addition to "core.notesRef". This reads a colon separated list of notes refs from the user. The values are stored in the Git variable notes.displayRef. With a prefix argument GLOBAL change the global values instead of the values in the current repository.

It is possible to merge one note ref into another. That may result in conflicts which have to resolved in the temporary worktree ".git/NOTES_MERGE_WORKTREE".

T m     (magit-notes-merge)

Merge the notes of a ref read from the user into the current notes ref. The current notes ref is the value of Git variable core.notesRef or "refs/notes/commits" if that is undefined.

When a notes merge is in progress then the popup features the following suffix commands, instead of those listed above.

T c     (magit-notes-merge-commit)

Commit the current notes ref merge, after manually resolving conflicts.

T a     (magit-notes-merge-abort)

Abort the current notes ref merge.