From: Eli Zaretskii <eliz@gnu.org>
Date: Sat, 7 Jul 2018 09:50:22 +0000 (+0300)
Subject: Improve documentation of 'emacs-lock-mode'
X-Git-Tag: emacs-26.1.90~290
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=3a04e151af310ff0a283b1f05315c09baf5d7acf;p=emacs.git

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'.
---

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