From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Tue, 17 May 2022 18:01:11 +0000 (+0200)
Subject: Explain more about jit-lock-mode calling conventions
X-Git-Tag: emacs-29.0.90~1910^2~619
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=514cfbb267ee678f5b2d6aa6c9824fb32b3ac69d;p=emacs.git

Explain more about jit-lock-mode calling conventions

* lisp/jit-lock.el (jit-lock-mode): Explicitly explain ARG
(bug#55451).
---

diff --git a/lisp/jit-lock.el b/lisp/jit-lock.el
index 20c12024745..17969d57620 100644
--- a/lisp/jit-lock.el
+++ b/lisp/jit-lock.el
@@ -217,6 +217,11 @@ If the system load rises above `jit-lock-stealth-load' percent, stealth
 fontification is suspended.  Stealth fontification intensity is controlled via
 the variable `jit-lock-stealth-nice'.
 
+`jit-lock-mode' is not a regular minor mode, and it doesn't
+follow the regular conventions to switch the functionality on or
+off.  Instead, an ARG of nil will switch it off, and non-nil will
+switch it on.
+
 If you need to debug code run from jit-lock, see `jit-lock-debug-mode'."
   (setq jit-lock-mode arg)
   (cond