]> git.eshelyaron.com Git - emacs.git/commitdiff
Explain more about jit-lock-mode calling conventions
authorLars Ingebrigtsen <larsi@gnus.org>
Tue, 17 May 2022 18:01:11 +0000 (20:01 +0200)
committerLars Ingebrigtsen <larsi@gnus.org>
Tue, 17 May 2022 18:01:11 +0000 (20:01 +0200)
* lisp/jit-lock.el (jit-lock-mode): Explicitly explain ARG
(bug#55451).

lisp/jit-lock.el

index 20c12024745942392810f97f04c0a236d5e5a2b7..17969d5762012e40046a2e3929ba2818270cbaa2 100644 (file)
@@ -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