>From 7a9aacd3a4d5f0a98050502f624aea3cbb4e6ce0 Mon Sep 17 00:00:00 2001
From: Alexander Gramiak
Date: Mon, 17 Jul 2017 14:14:45 -0600
Subject: [PATCH] Document display-line-numbers-mode
* doc/emacs/custom.texi (Init Rebinding): Re-add entry that used to
belong to linum-mode.
* doc/emacs/modes.texi (Minor Modes): Summarize the mode.
* etc/NEWS: Document display-line-numbers-mode and its customization
variables, and mention that display-line-numbers-width is
buffer-local.
---
doc/emacs/custom.texi | 1 +
doc/emacs/modes.texi | 7 +++++++
etc/NEWS | 44 +++++++++++++++++++++++++++++---------------
3 files changed, 37 insertions(+), 15 deletions(-)
diff --git a/doc/emacs/custom.texi b/doc/emacs/custom.texi
index a756a89e3f..1c9c14a962 100644
--- a/doc/emacs/custom.texi
+++ b/doc/emacs/custom.texi
@@ -1701,6 +1701,7 @@ Init Rebinding
(global-set-key (kbd "C-c y") 'clipboard-yank)
(global-set-key (kbd "C-M-q") 'query-replace)
(global-set-key (kbd "") 'flyspell-mode)
+(global-set-key (kbd "C-") 'display-line-numbers-mode)
(global-set-key (kbd "C-") 'forward-sentence)
(global-set-key (kbd "") 'mouse-save-then-kill)
@end example
diff --git a/doc/emacs/modes.texi b/doc/emacs/modes.texi
index eb0c88b290..876431aa9e 100644
--- a/doc/emacs/modes.texi
+++ b/doc/emacs/modes.texi
@@ -225,6 +225,13 @@ Minor Modes
programs. It is enabled globally by default, but you can disable it
in individual buffers. @xref{Faces}.
address@hidden display-line-numbers-mode
address@hidden display-line-numbers-mode
address@hidden
+Display Line Numbers mode is a convenience wrapper around
address@hidden, setting it using the value of
address@hidden @xref{Display Custom}.
+
@item
Outline minor mode provides similar facilities to the major mode
called Outline mode. @xref{Outline Mode}.
diff --git a/etc/NEWS b/etc/NEWS
index edb71118ef..ccc9984c4c 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -424,13 +424,18 @@ range of indentation.
This is similar to what linum-mode provides, but much faster and
doesn't usurp the display margin for the line numbers. Customize the
buffer-local variable 'display-line-numbers' to activate this optional
-display. If set to t, Emacs will display the number of each line
-before the line. If set to 'relative', Emacs will display the line
-number relative to the line showing point, with that line's number
-displayed as absolute. If set to 'visual', Emacs will display a
-relative number for every screen line, i.e. it will count screen lines
-rather than buffer lines. The default is nil, which doesn't display
-the line numbers.
+display. Alternatively, you can use the `display-line-numbers-mode'
+minor mode or the global `global-display-line-numbers-mode'. When
+using these modes, customize `display-line-numbers-type' with the same
+value as you would use with `display-line-numbers'.
+
+If `display-line-numbers' is set to t, Emacs will display the number
+of each line before the line. If set to 'relative', Emacs will
+display the line number relative to the line showing point, with that
+line's number displayed as absolute. If set to 'visual', Emacs will
+display a relative number for every screen line, i.e. it will count
+screen lines rather than buffer lines. The default is nil, which
+doesn't display the line numbers.
In 'relative' and 'visual' modes, the variable
'display-line-numbers-current-absolute' controls what number is
@@ -448,14 +453,23 @@ new face 'line-number-current-line' can be customized to display the
current line's number differently from all the other line numbers; by
default these two faces are identical.
-You can also customize the new variable 'display-line-numbers-width' to
-specify a fixed minimal with of the area allocated to line-number
-display. The default is nil, meaning that Emacs will dynamically
-calculate the area width, enlarging or shrinking it as needed.
-Setting it to a non-negative integer specifies that as the minimal
-width; selecting a value that is large enough to display all line
-numbers in a buffer will then keep the line-number display area of
-constant width at all times, if that is desired.
+You can also customize the new buffer-local variable
+'display-line-numbers-width' to specify a fixed minimal with of the
+area allocated to line-number display. The default is nil, meaning
+that Emacs will dynamically calculate the area width, enlarging or
+shrinking it as needed. Setting it to a non-negative integer
+specifies that as the minimal width; selecting a value that is large
+enough to display all line numbers in a buffer will then keep the
+line-number display area of constant width at all times, if that is
+desired.
+
+When using `display-line-numbers-mode', you can customize the variable
+`display-line-numbers-grow-only' to a non-nil value; this means that
+Emacs may grow the above area width dynamically, but never shrink it.
+Under this mode, customizing the variable
+`display-line-numbers-width-start' to a non-nil value will cause Emacs
+to set `display-line-numbers-width' to the minimum width necessary to
+display all line numbers in the current buffer when first visiting it.
Lisp programs can disable line-number display for a particular screen
line by putting the 'display-line-numbers-disable' text property or
--
2.13.2