summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStefan Kangas <stefankangas@gmail.com>2022-12-08 02:00:13 +0100
committerStefan Kangas <stefankangas@gmail.com>2022-12-08 02:09:40 +0100
commit888558ec425031e878c4243b205bd281134c10b2 (patch)
tree3b6f5032a46e9f5ce6c2635396d74aa28967df34
parent537f11f8cd188dda6524dd7e2148d318537d4690 (diff)
downloademacs-888558ec42.tar.gz
Improve bind-keys* and override-global-mode docstrings
* lisp/use-package/bind-key.el (bind-keys*): Add docstring. (override-global-mode) Improve docstring.
-rw-r--r--lisp/use-package/bind-key.el18
1 files changed, 17 insertions, 1 deletions
diff --git a/lisp/use-package/bind-key.el b/lisp/use-package/bind-key.el
index 3168f686a09..9ebb859a359 100644
--- a/lisp/use-package/bind-key.el
+++ b/lisp/use-package/bind-key.el
@@ -128,7 +128,18 @@
"Keymap for `override-global-mode'.")
(define-minor-mode override-global-mode
- "A minor mode so that keymap settings override other modes."
+ "A minor mode for allowing keybindings to override other modes.
+The main purpose of this mode is to simplify bindings keys in
+such a way that they take precedence over other modes.
+
+To achieve this, the keymap `override-global-map' is added to
+`emulation-mode-map-alists', which makes it take precedence over
+keymaps in `minor-mode-map-alist'. Thereby, key bindings get an
+even higher precedence than global key bindings defined with
+`keymap-global-set' (or, in Emacs 28 or older, `global-set-key').
+
+The macro `bind-key*' (which see) provides a convenient way to
+add keys to that keymap."
:init-value t
:lighter "")
@@ -425,6 +436,11 @@ function symbol (unquoted)."
;;;###autoload
(defmacro bind-keys* (&rest args)
+ "Bind multiple keys at once, in `override-global-map'.
+Accepts the same keyword arguments as `bind-keys' (which see).
+
+This binds keys in such a way that bindings are not overridden by
+other modes. See `override-global-mode'."
(macroexp-progn (bind-keys-form args 'override-global-map)))
(defun get-binding-description (elem)