From: Michael Albinus Date: Thu, 19 Dec 2024 09:40:52 +0000 (+0100) Subject: Fix display of obsolete variables in *Help* X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=ce553fd45dc412052a75ddd8b82c9608003727df;p=emacs.git Fix display of obsolete variables in *Help* * doc/lispref/variables.texi (Variable Aliases): Mention `substitute-command-keys' in `make-obsolete-variable'. * lisp/font-lock.el: Revert last change. * lisp/help-fns.el (help-fns--var-obsolete): Apply `substitute-command-keys'. * lisp/emacs-lisp/byte-run.el (make-obsolete-variable): Adapt docstring. (cherry picked from commit 1647086d6a3a560877f386b9d153c01270307f68) --- diff --git a/doc/lispref/variables.texi b/doc/lispref/variables.texi index 0e9124920d1..5010fea24a0 100644 --- a/doc/lispref/variables.texi +++ b/doc/lispref/variables.texi @@ -2647,10 +2647,10 @@ This function makes the byte compiler warn that the variable @var{obsolete-name} is obsolete. If @var{current-name} is a symbol, it is the variable's new name; then the warning message says to use @var{current-name} instead of @var{obsolete-name}. If -@var{current-name} is a string, this is the message and there is no -replacement variable. @var{when} should be a string indicating when -the variable was first made obsolete (usually a version number -string). +@var{current-name} is a string, this is the message (after passing +through @code{substitute-command-keys}) and there is no replacement +variable. @var{when} should be a string indicating when the variable +was first made obsolete (usually a version number string). The optional argument @var{access-type}, if non-@code{nil}, should specify the kind of access that will trigger obsolescence warnings; it diff --git a/lisp/emacs-lisp/byte-run.el b/lisp/emacs-lisp/byte-run.el index 53c62952f96..3e9613e8182 100644 --- a/lisp/emacs-lisp/byte-run.el +++ b/lisp/emacs-lisp/byte-run.el @@ -571,7 +571,8 @@ See the docstrings of `defalias' and `make-obsolete' for more details." &optional access-type) "Make the byte-compiler warn that OBSOLETE-NAME is obsolete. The warning will say that CURRENT-NAME should be used instead. -If CURRENT-NAME is a string, that is the `use instead' message. +If CURRENT-NAME is a string, that is the `use instead' message. If it +is a string, it is passed through `substitute-command-keys'. WHEN should be a string indicating when the variable was first made obsolete, for example a date or a release number. ACCESS-TYPE if non-nil should specify the kind of access that will trigger diff --git a/lisp/font-lock.el b/lisp/font-lock.el index 21c290c4e3d..dd33c2382fc 100644 --- a/lisp/font-lock.el +++ b/lisp/font-lock.el @@ -309,86 +309,86 @@ If a number, only buffers greater than this size have fontification messages." (make-obsolete-variable 'font-lock-comment-face - "use the quoted symbol instead: 'font-lock-comment-face" "31.1") + "use the quoted symbol instead: \\='font-lock-comment-face" "31.1") (defvar font-lock-comment-face 'font-lock-comment-face "Face name to use for comments.") (make-obsolete-variable 'font-lock-comment-delimiter-face - "use the quoted symbol instead: 'font-lock-comment-delimiter-face" "31.1") + "use the quoted symbol instead: \\='font-lock-comment-delimiter-face" "31.1") (defvar font-lock-comment-delimiter-face 'font-lock-comment-delimiter-face "Face name to use for comment delimiters.") (make-obsolete-variable 'font-lock-string-face - "use the quoted symbol instead: 'font-lock-string-face" "31.1") + "use the quoted symbol instead: \\='font-lock-string-face" "31.1") (defvar font-lock-string-face 'font-lock-string-face "Face name to use for strings.") (make-obsolete-variable 'font-lock-doc-face - "use the quoted symbol instead: 'font-lock-doc-face" "31.1") + "use the quoted symbol instead: \\='font-lock-doc-face" "31.1") (defvar font-lock-doc-face 'font-lock-doc-face "Face name to use for documentation.") (make-obsolete-variable 'font-lock-doc-markup-face - "use the quoted symbol instead: 'font-lock-doc-markup-face" "31.1") + "use the quoted symbol instead: \\='font-lock-doc-markup-face" "31.1") (defvar font-lock-doc-markup-face 'font-lock-doc-markup-face "Face name to use for documentation mark-up.") (make-obsolete-variable 'font-lock-keyword-face - "use the quoted symbol instead: 'font-lock-keyword-face" "31.1") + "use the quoted symbol instead: \\='font-lock-keyword-face" "31.1") (defvar font-lock-keyword-face 'font-lock-keyword-face "Face name to use for keywords.") (make-obsolete-variable 'font-lock-builtin-face - "use the quoted symbol instead: 'font-lock-builtin-face" "31.1") + "use the quoted symbol instead: \\='font-lock-builtin-face" "31.1") (defvar font-lock-builtin-face 'font-lock-builtin-face "Face name to use for builtins.") (make-obsolete-variable 'font-lock-function-name-face - "use the quoted symbol instead: 'font-lock-function-name-face" "31.1") + "use the quoted symbol instead: \\='font-lock-function-name-face" "31.1") (defvar font-lock-function-name-face 'font-lock-function-name-face "Face name to use for function names.") (make-obsolete-variable 'font-lock-variable-name-face - "use the quoted symbol instead: 'font-lock-variable-name-face" "31.1") + "use the quoted symbol instead: \\='font-lock-variable-name-face" "31.1") (defvar font-lock-variable-name-face 'font-lock-variable-name-face "Face name to use for variable names.") (make-obsolete-variable 'font-lock-type-face - "use the quoted symbol instead: 'font-lock-type-face" "31.1") + "use the quoted symbol instead: \\='font-lock-type-face" "31.1") (defvar font-lock-type-face 'font-lock-type-face "Face name to use for type and class names.") (make-obsolete-variable 'font-lock-constant-face - "use the quoted symbol instead: 'font-lock-constant-face" "31.1") + "use the quoted symbol instead: \\='font-lock-constant-face" "31.1") (defvar font-lock-constant-face 'font-lock-constant-face "Face name to use for constant and label names.") (make-obsolete-variable 'font-lock-warning-face - "use the quoted symbol instead: 'font-lock-warning-face" "31.1") + "use the quoted symbol instead: \\='font-lock-warning-face" "31.1") (defvar font-lock-warning-face 'font-lock-warning-face "Face name to use for things that should stand out.") (make-obsolete-variable 'font-lock-negation-char-face - "use the quoted symbol instead: 'font-lock-negation-char-face" "31.1") + "use the quoted symbol instead: \\='font-lock-negation-char-face" "31.1") (defvar font-lock-negation-char-face 'font-lock-negation-char-face "Face name to use for easy to overlook negation. This can be an \"!\" or the \"n\" in \"ifndef\".") (make-obsolete-variable 'font-lock-preprocessor-face - "use the quoted symbol instead: 'font-lock-preprocessor-face" "31.1") + "use the quoted symbol instead: \\='font-lock-preprocessor-face" "31.1") (defvar font-lock-preprocessor-face 'font-lock-preprocessor-face "Face name to use for preprocessor directives.") diff --git a/lisp/help-fns.el b/lisp/help-fns.el index 1f3527128b3..3c24a290859 100644 --- a/lisp/help-fns.el +++ b/lisp/help-fns.el @@ -1779,7 +1779,7 @@ variable.\n"))) (insert "This variable is obsolete") (if (nth 2 obsolete) (insert (format " since %s" (nth 2 obsolete)))) - (insert (cond ((stringp use) (concat "; " use)) + (insert (cond ((stringp use) (substitute-command-keys (concat "; " use))) (use (format-message "; use `%s' instead." (car obsolete))) (t "."))