Variable: magit-ediff-show-stash-with-index

magit-ediff-show-stash-with-index is a customizable variable defined in magit-ediff.el.

Value

t

Documentation

Whether magit-ediff-show-stash shows the state of the index.

If non-nil, use a third Ediff buffer to distinguish which changes in the stash were staged. In cases where the stash contains no staged changes, fall back to a two-buffer Ediff.

More specifically, a stash is a merge commit, stash@{N}, with potentially three parents.

* stash@{N}^1 represents the HEAD commit at the time the stash
  was created.

* stash@{N}^2 records any changes that were staged when the stash
  was made.

* stash@{N}^3, if it exists, contains files that were untracked
  when stashing.

If this option is non-nil, magit-ediff-show-stash will run Ediff on a file using three buffers: one for stash@{N}, another for stash@{N}^1, and a third for stash@{N}^2.

Otherwise, Ediff uses two buffers, comparing stash@{N}^1..stash@{N}. Along with any unstaged changes, changes in the index commit, stash@{N}^2, will be shown in this comparison unless they conflicted with changes in the working tree at the time of stashing.

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

Source Code

;; Defined in ~/.emacs.d/elpa/magit-20260411.1452/magit-ediff.el
(defcustom magit-ediff-show-stash-with-index t
  "Whether `magit-ediff-show-stash' shows the state of the index.

If non-nil, use a third Ediff buffer to distinguish which changes
in the stash were staged.  In cases where the stash contains no
staged changes, fall back to a two-buffer Ediff.

More specifically, a stash is a merge commit, stash@{N}, with
potentially three parents.

* stash@{N}^1 represents the `HEAD' commit at the time the stash
  was created.

* stash@{N}^2 records any changes that were staged when the stash
  was made.

* stash@{N}^3, if it exists, contains files that were untracked
  when stashing.

If this option is non-nil, `magit-ediff-show-stash' will run
Ediff on a file using three buffers: one for stash@{N}, another
for stash@{N}^1, and a third for stash@{N}^2.

Otherwise, Ediff uses two buffers, comparing
stash@{N}^1..stash@{N}.  Along with any unstaged changes, changes
in the index commit, stash@{N}^2, will be shown in this
comparison unless they conflicted with changes in the working
tree at the time of stashing."
  :package-version '(magit . "2.6.0")
  :group 'magit-ediff
  :type 'boolean)