From 59b7086838e3f82c76977ae0f79b862ab2e7a782 Mon Sep 17 00:00:00 2001 From: Phil Sainty Date: Sun, 14 Aug 2022 23:14:51 +1200 Subject: [PATCH] Improve docs for global-mode-string / %M construct * src/xdisp.c (global-mode-string): Update docstring. * doc/lispref/modes.texi: Update manual. --- doc/lispref/modes.texi | 25 +++++++++++++++---------- src/xdisp.c | 2 +- 2 files changed, 16 insertions(+), 11 deletions(-) diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi index d011962ade7..610ea696e74 100644 --- a/doc/lispref/modes.texi +++ b/doc/lispref/modes.texi @@ -2357,18 +2357,19 @@ enabled separately in each buffer. @defvar global-mode-string This variable holds a mode line construct that, by default, appears in -the mode line just after the @code{which-function-mode} minor mode if -set, else after @code{mode-line-modes}. Elements that are added to -this construct should normally end in a space (to ensure that -consecutive @code{global-mode-string} elements display properly). For -instance, the command @code{display-time} sets -@code{global-mode-string} to refer to the variable -@code{display-time-string}, which holds a string containing the time -and load information. +the mode line as part of @code{mode-line-misc-info}, just after the +@code{which-function-mode} information if that minor mode is enabled, +else after @code{mode-line-modes}. Elements that are added to this +construct should normally end in a space (to ensure that consecutive +@code{global-mode-string} elements display properly). For instance, +the command @code{display-time} sets @code{global-mode-string} to +refer to the variable @code{display-time-string}, which holds a string +containing the time and load information. The @samp{%M} construct substitutes the value of -@code{global-mode-string}, but that is obsolete, since the variable is -included in the mode line from @code{mode-line-format}. +@code{global-mode-string}. This construct is not used by the default +mode line, as the variable itself is used in +@code{mode-line-misc-info}. @end defvar Here is a simplified version of the default value of @@ -2448,6 +2449,10 @@ abbreviate. The current line number of point, counting within the accessible portion of the buffer. +@item %M +The value of @code{global-mode-string} (which is part of +@code{mode-line-misc-info} by default). + @item %n @samp{Narrow} when narrowing is in effect; nothing otherwise (see @code{narrow-to-region} in @ref{Narrowing}). diff --git a/src/xdisp.c b/src/xdisp.c index 6219bb9ec6e..0b190529404 100644 --- a/src/xdisp.c +++ b/src/xdisp.c @@ -36470,7 +36470,7 @@ This is used for internal purposes. */); Vinhibit_redisplay = Qnil; DEFVAR_LISP ("global-mode-string", Vglobal_mode_string, - doc: /* String (or mode line construct) included (normally) in `mode-line-format'. */); + doc: /* String (or mode line construct) included (normally) in `mode-line-misc-info'. */); Vglobal_mode_string = Qnil; DEFVAR_LISP ("overlay-arrow-position", Voverlay_arrow_position, -- 2.39.2