branch: elpa/git-commit
commit 5a8e3aec35d64939e5a46430bdfce773a78cd44b
Author: Jonas Bernoulli <jo...@bernoul.li>
Commit: Jonas Bernoulli <jo...@bernoul.li>
magit-commit-diff-inhibit-same-window: New option
Different users need mutually exclusive kludges,
therefore we need an option. See #4132 for details.
---
Documentation/magit.org | 31 +++++++++++++++++++++++++++++--
Documentation/magit.texi | 32 ++++++++++++++++++++++++++++++--
lisp/magit-commit.el | 34 +++++++++++++++++++++++++++++++++-
3 files changed, 92 insertions(+), 5 deletions(-)
diff --git a/Documentation/magit.org b/Documentation/magit.org
index 5ce56ff..01251e3 100644
--- a/Documentation/magit.org
+++ b/Documentation/magit.org
@@ -8,7 +8,7 @@
#+TEXINFO_DIR_CATEGORY: Emacs
#+TEXINFO_DIR_TITLE: Magit: (magit).
#+TEXINFO_DIR_DESC: Using Git from Emacs with Magit.
-#+SUBTITLE: for version 3.2.1 (v3.2.1-58-g2fe42f63+1)
+#+SUBTITLE: for version 3.2.1 (v3.2.1-61-ge404aa75a+1)
#+TEXINFO_DEFFN: t
#+OPTIONS: H:4 num:3 toc:2
@@ -25,7 +25,7 @@ directly from within Emacs. While many fine Git clients
exist, only
Magit and Git itself deserve to be called porcelains.
#+TEXINFO: @noindent
-This manual is for Magit version 3.2.1 (v3.2.1-58-g2fe42f63+1).
+This manual is for Magit version 3.2.1 (v3.2.1-61-ge404aa75a+1).
#+BEGIN_QUOTE
Copyright (C) 2015-2021 Jonas Bernoulli <jo...@bernoul.li>
@@ -4482,6 +4482,33 @@ Also see [[man:git-commit]]
Also see ~git-commit-post-finish-hook~.
+- User Option: magit-commit-diff-inhibit-same-window
+
+ Whether to inhibit use of same window when showing diff while
+ committing.
+
+ When writing a commit, then a diff of the changes to be committed
+ is automatically shown. The idea is that the diff is shown in a
+ different window of the same frame and for most users that just
+ works. In other words most users can completely ignore this
+ option because its value doesn't make a difference for them.
+
+ However for users who configured Emacs to never create a new
+ window even when the package explicitly tries to do so, then
+ displaying two new buffers necessarily means that the first is
+ immediately replaced by the second. In our case the message
+ buffer is immediately replaced by the diff buffer, which is of
+ course highly undesirable.
+
+ A workaround is to suppress this user configuration in this
+ particular case. Users have to explicitly opt-in by toggling
+ this option. We cannot enable the workaround unconditionally
+ because that again causes issues for other users: if the frame
+ is too tiny or the relevant settings too aggressive, then the
+ diff buffer would end up being displayed in a new frame.
+
+ Also see https://github.com/magit/magit/issues/4132.
+
*** Editing Commit Messages
After initiating a commit as described in the previous section, two new
diff --git a/Documentation/magit.texi b/Documentation/magit.texi
index 7af6d66..5d5bd8c 100644
--- a/Documentation/magit.texi
+++ b/Documentation/magit.texi
@@ -31,7 +31,7 @@ General Public License for more details.
@finalout
@titlepage
@title Magit User Manual
-@subtitle for version 3.2.1 (v3.2.1-58-g2fe42f63+1)
+@subtitle for version 3.2.1 (v3.2.1-61-ge404aa75a+1)
@author Jonas Bernoulli
@page
@vskip 0pt plus 1filll
@@ -53,7 +53,7 @@ directly from within Emacs. While many fine Git clients
exist, only
Magit and Git itself deserve to be called porcelains.
@noindent
-This manual is for Magit version 3.2.1 (v3.2.1-58-g2fe42f63+1).
+This manual is for Magit version 3.2.1 (v3.2.1-61-ge404aa75a+1).
@quotation
Copyright (C) 2015-2021 Jonas Bernoulli <jonas@@bernoul.li>
@@ -6099,6 +6099,34 @@ the commit message in a buffer.
Also see @code{git-commit-post-finish-hook}.
@end defopt
+@defopt magit-commit-diff-inhibit-same-window
+
+Whether to inhibit use of same window when showing diff while
+committing.
+
+When writing a commit, then a diff of the changes to be committed
+is automatically shown. The idea is that the diff is shown in a
+different window of the same frame and for most users that just
+works. In other words most users can completely ignore this
+option because its value doesn't make a difference for them.
+
+However for users who configured Emacs to never create a new
+window even when the package explicitly tries to do so, then
+displaying two new buffers necessarily means that the first is
+immediately replaced by the second. In our case the message
+buffer is immediately replaced by the diff buffer, which is of
+course highly undesirable.
+
+A workaround is to suppress this user configuration in this
+particular case. Users have to explicitly opt-in by toggling
+this option. We cannot enable the workaround unconditionally
+because that again causes issues for other users: if the frame
+is too tiny or the relevant settings too aggressive, then the
+diff buffer would end up being displayed in a new frame.
+
+Also see @uref{https://github.com/magit/magit/issues/4132}.
+@end defopt
+
@node Editing Commit Messages
@subsection Editing Commit Messages
diff --git a/lisp/magit-commit.el b/lisp/magit-commit.el
index 51f6405..133ef4b 100644
--- a/lisp/magit-commit.el
+++ b/lisp/magit-commit.el
@@ -91,6 +91,34 @@ Also see `git-commit-post-finish-hook'."
:group 'magit-commands
:type 'hook)
+(defcustom magit-commit-diff-inhibit-same-window nil
+ "Whether to inhibit use of same window when showing diff while committing.
+
+When writing a commit, then a diff of the changes to be committed
+is automatically shown. The idea is that the diff is shown in a
+different window of the same frame and for most users that just
+works. In other words most users can completely ignore this
+option because its value doesn't make a difference for them.
+
+However for users who configured Emacs to never create a new
+window even when the package explicitly tries to do so, then
+displaying two new buffers necessarily means that the first is
+immediately replaced by the second. In our case the message
+buffer is immediately replaced by the diff buffer, which is of
+course highly undesirable.
+
+A workaround is to suppress this user configuration in this
+particular case. Users have to explicitly opt-in by toggling
+this option. We cannot enable the workaround unconditionally
+because that again causes issues for other users: if the frame
+is too tiny or the relevant settings too aggressive, then the
+diff buffer would end up being displayed in a new frame.
+
+Also see https://github.com/magit/magit/issues/4132.";
+ :package-version '(magit . "3.3.0")
+ :group 'magit-commands
+ :type 'boolean)
+
(defvar magit-post-commit-hook-commands
'(magit-commit-extend
magit-commit-fixup
@@ -574,7 +602,11 @@ See `magit-commit-absorb' for an alternative
implementation."
(magit-inhibit-save-previous-winconf 'unset)
(magit-display-buffer-noselect t)
(inhibit-quit nil)
- (display-buffer-overriding-action '(nil (inhibit-same-window
t))))
+ (display-buffer-overriding-action
+ display-buffer-overriding-action))
+ (when magit-commit-diff-inhibit-same-window
+ (setq display-buffer-overriding-action
+ '(nil (inhibit-same-window t))))
(message "Diffing changes to be committed (C-g to abort diffing)")
(cl-case last-command
(magit-commit
