]> git.eshelyaron.com Git - emacs.git/commitdiff
; Clarify doc string of 'long-line-threshold'
authorEli Zaretskii <eliz@gnu.org>
Thu, 21 Jul 2022 12:59:50 +0000 (15:59 +0300)
committerEli Zaretskii <eliz@gnu.org>
Thu, 21 Jul 2022 12:59:50 +0000 (15:59 +0300)
* src/buffer.c (syms_of_buffer) <long-line-threshold>: Clarify the
doc string.

src/buffer.c

index a55af906e26df123969441dbb1681584d4f3ff49..a07194aef7227987b07328f846968e92f10343a3 100644 (file)
@@ -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);