]> git.eshelyaron.com Git - emacs.git/commitdiff
Documentation improvements for 'display-line-numbers'
authorEli Zaretskii <eliz@gnu.org>
Sat, 23 Sep 2017 07:07:11 +0000 (10:07 +0300)
committerEli Zaretskii <eliz@gnu.org>
Sat, 23 Sep 2017 07:07:11 +0000 (10:07 +0300)
* doc/emacs/display.texi (Display Custom): Document a few more
options for display-line-numbers.  (Bug#28533)  Fix a typo.

doc/emacs/display.texi

index 2aa79e1161a0beb33e9ccf66288e9d9dbdca8804..f074e989bc0b08fb8003ed448c6b65b15c35cc10 100644 (file)
@@ -1756,7 +1756,7 @@ Any other non-@code{nil} value is treated as @code{t}.
 @vindex display-line-numbers-type
 A convenient way of turning on display of line numbers is @w{@kbd{M-x
 display-line-numbers-mode @key{RET}}}.  This mode has a globalized
-variant, @code{global-display-line0numbers-mode}.  The user option
+variant, @code{global-display-line-numbers-mode}.  The user option
 @code{display-line-numbers-type} controls which sub-mode of
 line-number display, described above, will these modes activate.
 
@@ -1778,6 +1778,17 @@ the variable @code{display-line-numbers-widen} to a non-@code{nil}
 value, line numbers will disregard any narrowing and will start at the
 first character of the buffer.
 
+@vindex display-line-numbers-width-start
+@vindex display-line-numbers-grow-only
+@vindex display-line-numbers-width
+In selective display mode (@pxref{Selective Display}), and other modes
+that hide many lines from display (such as Outline and Org modes), you
+may wish to customize the variables
+@code{display-line-numbers-width-start} and
+@code{display-line-numbers-grow-only}, or set
+@code{display-line-numbers-width} to a large enough value, to avoid
+occasional miscalculations of space reserved for the line numbers.
+
 @cindex line-number face
 The line numbers are displayed in a special face @code{line-number}.
 The current line number is displayed in a different face,