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'.
This commit is contained in:
Eli Zaretskii 2018-07-07 12:50:22 +03:00
parent 9d6ca5ad4d
commit 3a04e151af

View file

@ -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:")