From: Phil Sainty <psainty@orcon.net.nz>
Date: Sun, 14 Aug 2022 11:16:48 +0000 (+1200)
Subject: * doc/lispref/modes.texi: Improve docs for obsolete '%m' construct
X-Git-Tag: emacs-29.0.90~89
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=9107b2dec1f7cab9062b65013b02c8601d205015;p=emacs.git

* doc/lispref/modes.texi: Improve docs for obsolete '%m' construct

Bug #57080.
---

diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi
index 610ea696e74..deaed31aed0 100644
--- a/doc/lispref/modes.texi
+++ b/doc/lispref/modes.texi
@@ -2523,13 +2523,16 @@ The character @samp{%}---this is how to include a literal @samp{%} in a
 string in which @code{%}-constructs are allowed.
 @end table
 
-The following @code{%}-construct is still supported, but it is
-obsolete, since you can get the same result using the variable
-@code{mode-name}.
+@subsubheading Obsolete @code{%}-Constructs
+
+  The following constructs should no longer be used.
 
 @table @code
 @item %m
-The value of @code{mode-name}.
+Obsolete; use the @code{mode-name} variable instead.  The @code{%m}
+construct is inadequate, as it produces an empty string if the value
+of @code{mode-name} is a non-string mode-line construct (as in
+@code{emacs-lisp-mode}, for example).
 @end table
 
 @node Properties in Mode