summaryrefslogtreecommitdiff
path: root/lisp/emacs-lock.el
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2018-07-07 12:50:22 +0300
committerEli Zaretskii <eliz@gnu.org>2018-07-07 12:50:22 +0300
commit3a04e151af310ff0a283b1f05315c09baf5d7acf (patch)
tree0e34e48116afa141913f55cc7d0476f2961cff56 /lisp/emacs-lock.el
parent9d6ca5ad4de832a0e8095ed1acf74d6bc18eb358 (diff)
downloademacs-3a04e151af310ff0a283b1f05315c09baf5d7acf.tar.gz
Improve documentation of 'emacs-lock-mode'
* lisp/emacs-lock.el (emacs-lock-mode): Mention in the doc string the special handling of some major modes due to 'emacs-lock-unlockable-modes'.
Diffstat (limited to 'lisp/emacs-lock.el')
-rw-r--r--lisp/emacs-lock.el10
1 files changed, 8 insertions, 2 deletions
diff --git a/lisp/emacs-lock.el b/lisp/emacs-lock.el
index 0a6fa9e6255..1c13d0ef975 100644
--- a/lisp/emacs-lock.el
+++ b/lisp/emacs-lock.el
@@ -94,7 +94,10 @@ It can be one of the following values:
exit -- Emacs cannot exit while the buffer is locked
kill -- the buffer cannot be killed, but Emacs can exit as usual
all -- the buffer is locked against both actions
- nil -- the buffer is not locked")
+ nil -- the buffer is not locked
+
+See also `emacs-lock-unlockable-modes', which exempts buffers under
+some major modes from being locked under some circumstances.")
(put 'emacs-lock-mode 'permanent-local t)
(defvar-local emacs-lock--old-mode nil
@@ -204,7 +207,10 @@ When called from Elisp code, ARG can be any locking mode:
kill -- the buffer cannot be killed, but Emacs can exit as usual
all -- the buffer is locked against both actions
-Other values are interpreted as usual."
+Other values are interpreted as usual.
+
+See also `emacs-lock-unlockable-modes', which exempts buffers under
+some major modes from being locked under some circumstances."
:init-value nil
:lighter (""
(emacs-lock--try-unlocking " locked:" " Locked:")