From: Sean Whitton <spwhitton@spwhitton.name>
Date: Sat, 19 Jul 2025 10:17:25 +0000 (+0100)
Subject: Include shorter bindings in diff-mode docstring
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=93f35d602a0a1f048e4011bbf4b89d3cfb853986;p=emacs.git

Include shorter bindings in diff-mode docstring

* lisp/vc/diff-mode.el (diff-read-only-map): New keymap,
factored out of code modifying minor-mode-map-alist.
(diff-mode): Include bindings from diff-read-only-map in
docstring (bug#34080).

(cherry picked from commit c56c56b3c68d274fda9cea171f1e530864ee634c)
---

diff --git a/lisp/vc/diff-mode.el b/lisp/vc/diff-mode.el
index f868eaf7c1b..91843b85dbe 100644
--- a/lisp/vc/diff-mode.el
+++ b/lisp/vc/diff-mode.el
@@ -179,6 +179,14 @@ The default \"-b\" means to ignore whitespace-only changes,
 ;;;; keymap, menu, ...
 ;;;;
 
+;; The additional bindings in read-only `diff-mode' buffers are not
+;; activated by turning on `diff-minor-mode' in those buffers.  Instead,
+;; a special entry in `minor-mode-map-alist' is used to achieve that.
+;; I.e., `diff-mode-read-only' is a pseudo-minor mode for read-only
+;; `diff-mode' buffers, while `diff-minor-mode' is a bona fide minor
+;; mode for non-`diff-mode' buffers.  (It's not clear there are
+;; practical uses for `diff-minor-mode': bug#34080).
+
 (defvar-keymap diff-mode-shared-map
   :doc "Additional bindings for read-only `diff-mode' buffers.
 These bindings are also available with an ESC prefix
@@ -1597,12 +1605,14 @@ else cover the whole buffer."
 (defvar-local diff-mode-read-only nil
   "Non-nil when read-only diff buffer uses short keys.")
 
+(defvar-keymap diff-read-only-map
+  :doc "Additional bindings for read-only `diff-mode' buffers."
+  :keymap (make-composed-keymap diff-mode-shared-map special-mode-map))
+
 ;; It should be lower than `outline-minor-mode' and `view-mode'.
 (or (assq 'diff-mode-read-only minor-mode-map-alist)
     (nconc minor-mode-map-alist
-           (list (cons 'diff-mode-read-only
-                       (make-composed-keymap diff-mode-shared-map
-                                             special-mode-map)))))
+           (list (cons 'diff-mode-read-only diff-read-only-map))))
 
 (defvar whitespace-style)
 (defvar whitespace-trailing-regexp)
@@ -1616,17 +1626,16 @@ else cover the whole buffer."
   "Major mode for viewing/editing context diffs.
 Supports unified and context diffs as well as, to a lesser extent, diffs
 in the old \"normal\" format.  (Unified diffs have become the standard,
-most commonly encountered format.)
-
-When the buffer is read-only, the ESC prefix is not necessary.
-If you edit the buffer manually, `diff-mode' will try to update the hunk
-headers for you on-the-fly.
+most commonly encountered format.)  If you edit the buffer manually,
+`diff-mode' will try to update the hunk headers for you on-the-fly.
 
 You can also switch between context diff and unified diff with \\[diff-context->unified],
 or vice versa with \\[diff-unified->context] and you can also reverse the direction of
 a diff with \\[diff-reverse-direction].
 
-\\{diff-mode-map}"
+\\{diff-mode-map}
+In read-only buffers the following bindings are also available:
+\\{diff-read-only-map}"
 
   (setq-local font-lock-defaults diff-font-lock-defaults)
   (add-hook 'font-lock-mode-hook #'diff--font-lock-cleanup nil 'local)