; * src/buffer.c (syms_of_buffer) <mode-line-format>: Doc fix.

This commit is contained in:
Eli Zaretskii 2022-07-18 15:31:26 +03:00
parent f5218385c0
commit 8f9993bb3f

View file

@ -5580,7 +5580,7 @@ the mode line appears at the bottom. */);
DEFVAR_PER_BUFFER ("mode-line-format", &BVAR (current_buffer, mode_line_format), DEFVAR_PER_BUFFER ("mode-line-format", &BVAR (current_buffer, mode_line_format),
Qnil, Qnil,
doc: /* Template for displaying mode line for current buffer. doc: /* Template for displaying mode line for a window's buffer.
The value may be nil, a string, a symbol or a list. The value may be nil, a string, a symbol or a list.
@ -5593,6 +5593,9 @@ For any symbol other than t or nil, the symbol's value is processed as
`risky-local-variable' property, all properties in any strings, as `risky-local-variable' property, all properties in any strings, as
well as all :eval and :propertize forms in the value, are ignored. well as all :eval and :propertize forms in the value, are ignored.
When the value is processed, the window's buffer is temporarily the
current buffer.
A list whose car is a string or list is processed by processing each A list whose car is a string or list is processed by processing each
of the list elements recursively, as separate mode line constructs, of the list elements recursively, as separate mode line constructs,
and concatenating the results. and concatenating the results.