Recommend using 'keymap-set' in Commentaries

* lisp/calendar/timeclock.el, lisp/comint.el, lisp/ehelp.el:
* lisp/gnus/gnus-bookmark.el, lisp/gnus/smiley.el, lisp/ido.el:
* lisp/isearchb.el, lisp/mail/mailabbrev.el, lisp/net/ange-ftp.el:
* lisp/net/goto-addr.el, lisp/play/fortune.el, lisp/saveplace.el:
* lisp/shell.el, lisp/term.el, lisp/textmodes/makeinfo.el:
* lisp/textmodes/refer.el, lisp/textmodes/remember.el:
* lisp/textmodes/table.el, lisp/woman.el: Recommend using
'keymap-set' instead of 'define-key' in Commentaries.

(cherry picked from commit ecd756dd391c1436820593e240f1f7b8a28b2c6e)

diff --git a/lisp/calendar/timeclock.el b/lisp/calendar/timeclock.el
index 5fa3ec333d4234b1e38d4852c5de2093c44b5621..5d32e37695feefa67b95016fc88e74d97fdcdc7e 100644 (file)
--- a/lisp/calendar/timeclock.el
+++ b/lisp/calendar/timeclock.el
@@ -37,12 +37,12 @@
 ;; You'll probably want to bind the timeclock commands to some handy
 ;; keystrokes.  Assuming C-c t is unbound, you might use:
 ;;
-;;   (define-key (kbd "C-c t i") 'timeclock-in)
-;;   (define-key (kbd "C-c t o") 'timeclock-out)
-;;   (define-key (kbd "C-c t c") 'timeclock-change)
-;;   (define-key (kbd "C-c t r") 'timeclock-reread-log)
-;;   (define-key (kbd "C-c t u") 'timeclock-update-mode-line)
-;;   (define-key (kbd "C-c t w") 'timeclock-when-to-leave-string)
+;;   (keymap-set "C-c t i" 'timeclock-in)
+;;   (keymap-set "C-c t o" 'timeclock-out)
+;;   (keymap-set "C-c t c" 'timeclock-change)
+;;   (keymap-set "C-c t r" 'timeclock-reread-log)
+;;   (keymap-set "C-c t u" 'timeclock-update-mode-line)
+;;   (keymap-set "C-c t w" 'timeclock-when-to-leave-string)
 
 ;; If you want Emacs to display the amount of time "left" to your
 ;; workday in the mode-line, you can either set the value of

diff --git a/lisp/comint.el b/lisp/comint.el
index 0b434462ffc22d470ed2434b479cadabc5708152..fd6b2abafce1214c9b8ac338336ece1f66c5badc 100644 (file)
--- a/lisp/comint.el
+++ b/lisp/comint.el
@@ -3207,8 +3207,8 @@ its response can be seen."
 
 ;; These are not installed in the comint-mode keymap.  But they are
 ;; available for people who want them.  Shell-mode installs them:
-;; (define-key shell-mode-map "\t" 'completion-at-point)
-;; (define-key shell-mode-map "\M-?"
+;; (keymap-set shell-mode-map "TAB" 'completion-at-point)
+;; (keymap-set shell-mode-map "M-?"
 ;;             'comint-dynamic-list-filename-completions)))
 ;;
 ;; Commands like this are fine things to put in load hooks if you

diff --git a/lisp/gnus/gnus-bookmark.el b/lisp/gnus/gnus-bookmark.el
index dbe587491ffa294e7f9fd4fbc8391cfb6d442070..6c07e15fa49fc2dbbe5793eacc13de01ae8aaca0 100644 (file)
--- a/lisp/gnus/gnus-bookmark.el
+++ b/lisp/gnus/gnus-bookmark.el
@@ -55,10 +55,10 @@
 (require 'gnus-sum)
 
 ;; FIXME: should avoid using C-c (no?)
-;; (define-key gnus-summary-mode-map "\C-crm" 'gnus-bookmark-set)
-;; (define-key global-map "\C-crb" 'gnus-bookmark-jump)
-;; (define-key global-map "\C-crj" 'gnus-bookmark-jump)
-;; (define-key global-map "\C-crl" 'gnus-bookmark-bmenu-list)
+;; (keymap-set gnus-summary-mode-map "C-c r m" 'gnus-bookmark-set)
+;; (keymap-global-set "C-c r b" 'gnus-bookmark-jump)
+;; (keymap-global-set "C-c r j" 'gnus-bookmark-jump)
+;; (keymap-global-set "C-c r l" 'gnus-bookmark-bmenu-list)
 
 ;; FIXME: Add keybindings, see
 ;; http://thread.gmane.org/gmane.emacs.gnus.general/63101/focus=63379 [dead link]

diff --git a/lisp/gnus/smiley.el b/lisp/gnus/smiley.el
index c8cbde28de622c546cca1cdf79244470a45657f8..8b023cd1dbb96d8bc9a2a13d9a4b27600de64891 100644 (file)
--- a/lisp/gnus/smiley.el
+++ b/lisp/gnus/smiley.el
@@ -189,12 +189,9 @@ regexp to replace with IMAGE.  IMAGE is the name of an image file in
                    smiley-cached-regexp-alist))))))))
 
 ;; Not implemented:
-;; (defvar smiley-mouse-map
-;;   (let ((map (make-sparse-keymap)))
-;;     (define-key map [down-mouse-2] 'ignore) ; override widget
-;;     (define-key map [mouse-2]
-;;       'smiley-mouse-toggle-buffer)
-;;     map))
+;; (defvar-keymap smiley-mouse-map
+;;   "<down-mouse-2>" #'ignore ; override widget
+;;   "<mouse-2>"      #'smiley-mouse-toggle-buffer)
 
 ;;;###autoload
 (defun smiley-region (start end)

diff --git a/lisp/ido.el b/lisp/ido.el
index 0b08a7ac1dcc5bae1a537f58200dc00af7cc32fb..3f1808f88a2e1f3b07b14a718a556cb42a197013 100644 (file)
--- a/lisp/ido.el
+++ b/lisp/ido.el
@@ -214,7 +214,7 @@
 ;; `ido-buffer-completion-map'.
 ;;
 ;; (with-eval-after-load 'ido
-;;   (define-key ido-common-completion-map " " 'ido-next-match))
+;;   (keymap-set ido-common-completion-map "SPC" 'ido-next-match))
 
 ;; Seeing all the matching buffers or files
 ;; ----------------------------------------

diff --git a/lisp/mail/mailabbrev.el b/lisp/mail/mailabbrev.el
index 15d697db6f9ef47647608372979cd6be9732b155..534f277ac57fbb351699e2f51dbe29b3d33314a2 100644 (file)
--- a/lisp/mail/mailabbrev.el
+++ b/lisp/mail/mailabbrev.el
@@ -109,8 +109,8 @@
 ;;  (add-hook
 ;;   'mail-mode-hook
 ;;   (lambda ()
-;;      (define-key mail-mode-map [remap next-line] 'mail-abbrev-next-line)
-;;      (define-key mail-mode-map [remap end-of-buffer] 'mail-abbrev-end-of-buffer)))
+;;      (keymap-set mail-mode-map "<remap> <next-line>" 'mail-abbrev-next-line)
+;;      (keymap-set mail-mode-map "<remap> <end-of-buffer>" 'mail-abbrev-end-of-buffer)))
 ;;
 ;; If you want multiple addresses separated by a string other than ", " then
 ;; you can set the variable mail-alias-separator-string to it.  This has to

diff --git a/lisp/net/ange-ftp.el b/lisp/net/ange-ftp.el
index f144c311293bca407a5efa1a1c49f307a9631507..ad1011cb5d8e88d7d7398bbd0495eec91b2624d7 100644 (file)
--- a/lisp/net/ange-ftp.el
+++ b/lisp/net/ange-ftp.el
@@ -1458,7 +1458,7 @@ only return the directory part of FILE."
 ;;;; ------------------------------------------------------------
 
 ;; (setq ange-ftp-tmp-keymap (make-sparse-keymap))
-;; (define-key ange-ftp-tmp-keymap "\C-m" 'exit-minibuffer)
+;; (keymap-set ange-ftp-tmp-keymap "C-m" 'exit-minibuffer)
 
 (defun ange-ftp-repaint-minibuffer ()
   "Clear any existing minibuffer message; let the minibuffer contents show."
@@ -4099,8 +4099,8 @@ E.g.,
 ;; Put these lines uncommented in your .emacs if you want C-r to refresh
 ;; ange-ftp's cache whilst doing filename completion.
 ;;
-;;(define-key minibuffer-local-completion-map "\C-r" 'ange-ftp-reread-dir)
-;;(define-key minibuffer-local-must-match-map "\C-r" 'ange-ftp-reread-dir)
+;;(keymap-set minibuffer-local-completion-map "C-r" 'ange-ftp-reread-dir)
+;;(keymap-set minibuffer-local-must-match-map "C-r" 'ange-ftp-reread-dir)
 
 ;;;###autoload
 (define-obsolete-function-alias 'ange-ftp-re-read-dir #'ange-ftp-reread-dir "29.1")

diff --git a/lisp/net/goto-addr.el b/lisp/net/goto-addr.el
index 08a14d407be368e50095a893e9154ec040d0c1e6..e095a66c7edc4dc18bd50b5a70f171a3850cab73 100644 (file)
--- a/lisp/net/goto-addr.el
+++ b/lisp/net/goto-addr.el
@@ -43,9 +43,8 @@
 ;; (for example):
 ;;
 ;; (setq goto-address-highlight-keymap
-;;   (let ((m (make-sparse-keymap)))
-;;     (define-key m [S-mouse-2] 'goto-address-at-point)
-;;     m))
+;;       (define-keymap
+;;         "S-<mouse-2>" 'goto-address-at-point))
 ;;
 
 ;; Known bugs/features:

diff --git a/lisp/play/fortune.el b/lisp/play/fortune.el
index 0fa98f486be24774beefdd599588fe7619959537..f917b3f701a578f07513aef7c5dc76792da2c1c2 100644 (file)
--- a/lisp/play/fortune.el
+++ b/lisp/play/fortune.el
@@ -57,9 +57,8 @@
 ;;
 ;; I also have this in my .gnus:
 ;;
-;;     (add-hook 'gnus-article-mode-hook
-;;               (lambda ()
-;;                 (define-key gnus-article-mode-map "i" #'fortune-from-region)))
+;;     (with-eval-after-load 'gnus-art
+;;       (keymap-set gnus-article-mode-map "i" #'fortune-from-region))
 ;;
 ;; which allows marking a region and then pressing "i" so that the marked
 ;; region will be automatically added to my favorite fortune file.

diff --git a/lisp/saveplace.el b/lisp/saveplace.el
index d4b82a01559c7954c1ecb8cdaa5cc1ca6e14dda6..35c88d4f6a438cd63be957ecc6a97f3c5aef0b90 100644 (file)
--- a/lisp/saveplace.el
+++ b/lisp/saveplace.el
@@ -38,7 +38,7 @@
 (require 'cl-lib)
 
 ;; this is what I was using during testing:
-;; (define-key ctl-x-map "p" 'toggle-save-place-globally)
+;; (keymap-set ctl-x-map "p" 'toggle-save-place-globally)
 
 (defgroup save-place nil
   "Automatically save place in files."

diff --git a/lisp/shell.el b/lisp/shell.el
index 565690dc93099e824071c7ad1f17d6aaafe217aa..12c50fb421dc3ac1c798f5087083ea5f068d5fa7 100644 (file)
--- a/lisp/shell.el
+++ b/lisp/shell.el
@@ -48,8 +48,8 @@
 ;; Some suggestions for your init file.
 ;;
 ;; ;; Define M-# to run some strange command:
-;; (eval-after-load "shell"
-;;  '(define-key shell-mode-map "\M-#" 'shells-dynamic-spell))
+;; (with-eval-after-load 'shell
+;;   (keymap-set shell-mode-map "M-#" 'shells-dynamic-spell))
 
 ;; Brief Command Documentation:
 ;;============================================================================

diff --git a/lisp/term.el b/lisp/term.el
index 2773dcb6ba6b326934116cecd922c74e229c9a31..4394f11033113dfc27319e6ebf3a80729db8e6c7 100644 (file)
--- a/lisp/term.el
+++ b/lisp/term.el
@@ -4197,8 +4197,8 @@ This is a good place to put keybindings.")
 
 ;; These are not installed in the term-mode keymap.  But they are
 ;; available for people who want them.  Shell-mode installs them:
-;; (define-key shell-mode-map "\t" 'term-dynamic-complete)
-;; (define-key shell-mode-map "\M-?"
+;; (keymap-set shell-mode-map "TAB" 'term-dynamic-complete)
+;; (keymap-set shell-mode-map "M-?"
 ;;             'term-dynamic-list-filename-completions)))
 ;;
 ;; Commands like this are fine things to put in load hooks if you

diff --git a/lisp/textmodes/makeinfo.el b/lisp/textmodes/makeinfo.el
index b2d58b41bfa429888051560912053753ca166ca3..9c1d0c5223a6e30dbd7444ea064324969f64974b 100644 (file)
--- a/lisp/textmodes/makeinfo.el
+++ b/lisp/textmodes/makeinfo.el
@@ -34,10 +34,10 @@
 ;;; Keybindings (defined in `texinfo.el')
 
 ;; makeinfo bindings
-; (define-key texinfo-mode-map "\C-c\C-m\C-r" 'makeinfo-region)
-; (define-key texinfo-mode-map "\C-c\C-m\C-b" 'makeinfo-buffer)
-; (define-key texinfo-mode-map "\C-c\C-m\C-k" 'kill-compilation)
-; (define-key texinfo-mode-map "\C-c\C-m\C-l"
+; (keymap-set texinfo-mode-map "C-c C-m C-r" 'makeinfo-region)
+; (keymap-set texinfo-mode-map "C-c C-m C-b" 'makeinfo-buffer)
+; (keymap-set texinfo-mode-map "C-c C-m C-k" 'kill-compilation)
+; (keymap-set texinfo-mode-map "C-c C-m C-l"
 ;   'makeinfo-recenter-compilation-buffer)
 \f
 ;;; Code:

diff --git a/lisp/textmodes/refer.el b/lisp/textmodes/refer.el
index 0e38c2e0969c1d9fdcdc9001cc54dd07942f4afe..c7569ea8f35216e06cbf562d3b0c27a8aabb8a6c 100644 (file)
--- a/lisp/textmodes/refer.el
+++ b/lisp/textmodes/refer.el
@@ -46,7 +46,7 @@
 ;;     refer-yank-key to insert it at point in the current buffer
 ;;     (typically as the argument of a \cite{} command).
 ;;
-;;     I use (define-key tex-mode-map    "\C-c\C-y"  'refer-yank-key)
+;;     I use (keymap-set tex-mode-map    "C-c C-y"  'refer-yank-key)
 ;;     to bind this often-used function to a key in (la)tex-mode.
 ;;
 ;;      If the list of bibliography files changes, reinitialize the variable

diff --git a/lisp/textmodes/remember.el b/lisp/textmodes/remember.el
index ac0dd384dda04ea8ec7471fb195bc55330e969b5..d04d811d78ff8b1e7582d89359d734e9086cd919 100644 (file)
--- a/lisp/textmodes/remember.el
+++ b/lisp/textmodes/remember.el
@@ -129,7 +129,7 @@
 ;; To map the primary remember function to the keystroke F8, do the
 ;; following.
 ;;
-;;   (define-key global-map [f8] 'remember)
+;;   (keymap-global-set "<f8>" 'remember)
 ;;
 ;; * Feedback
 ;;

diff --git a/lisp/textmodes/table.el b/lisp/textmodes/table.el
index aad14db6e95a9275cc06352f694d96dfbc4a352f..a33fb42477d17fdb7a753cbd37976ec86ab73e2c 100644 (file)
--- a/lisp/textmodes/table.el
+++ b/lisp/textmodes/table.el
@@ -343,7 +343,7 @@
 ;;
 ;;   (add-hook 'table-cell-map-hook
 ;;     (lambda ()
-;;       (define-key table-cell-map [<key sequence>] '<function>)))
+;;       (keymap-set table-cell-map "<key sequence>" '<function>)))
 ;;
 ;; -----
 ;; Menu:

diff --git a/lisp/woman.el b/lisp/woman.el
index c182afbf3136c24ecea4ab843f71b32bd2c59678..36d397bf1c72069c809141096bc1e67fdd9f8d48 100644 (file)
--- a/lisp/woman.el
+++ b/lisp/woman.el
@@ -86,9 +86,8 @@
 ;; structure.
 
 ;; Or (3): Put this in your init file:
-;; (add-hook 'dired-mode-hook
-;;          (lambda ()
-;;            (define-key dired-mode-map "W" 'woman-dired-find-file)))
+;; (with-eval-after-load 'dired
+;;   (keymap-set dired-mode-map "W" 'woman-dired-find-file))
 ;; and open the directory containing the man page file using Dired,
 ;; put the cursor on the file, and press `W'.