From: Eli Zaretskii <eliz@gnu.org>
Date: Thu, 21 Jul 2022 12:59:50 +0000 (+0300)
Subject: ; Clarify doc string of 'long-line-threshold'
X-Git-Tag: emacs-29.0.90~1447^2~820
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=72278f21e0ef0c79f756bca08577297d11e22518;p=emacs.git

; Clarify doc string of 'long-line-threshold'

* src/buffer.c (syms_of_buffer) <long-line-threshold>: Clarify the
doc string.
---

diff --git a/src/buffer.c b/src/buffer.c
index a55af906e26..a07194aef72 100644
--- a/src/buffer.c
+++ b/src/buffer.c
@@ -6430,11 +6430,13 @@ will run for `clone-indirect-buffer' calls as well.  */);
   Vclone_indirect_buffer_hook = Qnil;
 
   DEFVAR_LISP ("long-line-threshold", Vlong_line_threshold,
-	       doc: /* Line length above which specific display optimizations are used.
-Display optimizations for long lines will automatically be enabled in
-buffers which contain one or more lines whose length is above that
-threshold.
-When nil, these display optimizations are disabled.  */);
+    doc: /* Line length above which to use redisplay shortcuts.
+The value should be a positive integer or nil.
+If the value is an integer, shortcuts in the display code intended
+to speed up redisplay for long lines will automatically be enabled
+in buffers which contain one or more lines whose length is above
+this threshold.
+If nil, these display shortcuts will always remain disabled.  */);
   XSETFASTINT (Vlong_line_threshold, 10000);
 
   defsubr (&Sbuffer_live_p);