Function: git-commit-mode

git-commit-mode is an interactive and byte-compiled function defined in git-commit.el.

Signature

(git-commit-mode &optional ARG)

Documentation

Auxiliary minor mode used when editing Git commit messages.

This mode is only responsible for setting up some key bindings. Don't use it directly; instead enable global-git-commit-mode(var)/global-git-commit-mode(fun). Variable git-commit-major-mode controls which major-mode is used.

This is a minor mode. If called interactively, toggle the Git-Commit mode mode. If the prefix argument is positive, enable the mode, and if it is zero or negative, disable the mode.

If called from Lisp, toggle the mode if ARG is toggle. Enable the mode if ARG is nil, omitted, or is a positive number. Disable the mode if ARG is a negative number.

To check whether the minor mode is enabled in the current buffer, evaluate git-commit-mode(var)/git-commit-mode(fun).

The mode's hook is called both when the mode is enabled and when it is disabled.

Key Bindings

Source Code

;; Defined in ~/.emacs.d/elpa/magit-20260411.1452/git-commit.el
(define-minor-mode git-commit-mode
  "Auxiliary minor mode used when editing Git commit messages.
This mode is only responsible for setting up some key bindings.
Don't use it directly; instead enable `global-git-commit-mode'.
Variable `git-commit-major-mode' controls which major-mode is
used."
  :lighter "")