Variable: magit-show-process-buffer-hint

magit-show-process-buffer-hint is a customizable variable defined in magit-process.el.

Value

t

Documentation

Whether to append hint about process buffer to Git error messages.

When Magit runs Git for side-effects, the output is always logged to a per-repository process buffer. If Git exits with a non-zero status, then a single line of its error output is shown in the repositories status buffer and in the echo area.

When a user want to learn more about the error, they can switch to that process buffer, to see the complete output, but initially users are not aware of this, so Magit appends a usage hint to the error message in both of these places.

Once you are aware of this, you probably won't need the reminder and can set this option to nil.

See magit-process-display-mode-line-error for another way to display the complete output on demand.

This variable was added, or its default value changed, in magit version 4.3.7.

Source Code

;; Defined in ~/.emacs.d/elpa/magit-20260411.1452/magit-process.el
(defcustom magit-show-process-buffer-hint t
  "Whether to append hint about process buffer to Git error messages.

When Magit runs Git for side-effects, the output is always logged to
a per-repository process buffer.  If Git exits with a non-zero status,
then a single line of its error output is shown in the repositories
status buffer and in the echo area.

When a user want to learn more about the error, they can switch to that
process buffer, to see the complete output, but initially users are not
aware of this, so Magit appends a usage hint to the error message in
both of these places.

Once you are aware of this, you probably won't need the reminder and can
set this option to nil.

See `magit-process-display-mode-line-error' for another way to display
the complete output on demand."
  :package-version '(magit . "4.3.7")
  :group 'magit-process
  :type 'boolean)