bug#66240: [PATCH] ; Substitute quotes in obsoletion notice in 'C-h f'

bug#66240: [PATCH] ; Substitute quotes in obsoletion notice in 'C-h f'

[Eshel Yaron via Bug reports for GNU Emacs, the Swiss army knife of text editors]

[-- Attachment #1: Type: text/plain, Size: 354 bytes --]

Tags: patch

Hi,

Before this patch, `C-h f defadvice RET` says:

    This macro is obsolete since 30.1; use advice-add or define-advice

The symbols `advice-add` and `define-advice` are not fontified nor
buttonized.  With this patch the symbols are quoted like other symbols
in the *Help* buffer, and, more crucially, they're buttonized.

Best,

Eshel


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Substitute-quotes-in-obsoletion-notice-in-C-h-f.patch --]
[-- Type: text/patch, Size: 1726 bytes --]

From 1ff75d6daf59f8282544d3aea42ad2808f1469c9 Mon Sep 17 00:00:00 2001
From: Eshel Yaron <me@eshelyaron.com>
Date: Wed, 27 Sep 2023 18:27:12 +0200
Subject: [PATCH] ; Substitute quotes in obsoletion notice in 'C-h f'

* lisp/help-fns.el (help-fns--obsolete): Substitute quotes in string
arguments to 'obsolete' declarations.

* lisp/emacs-lisp/advice.el (defadvice): Markup symbols in 'obsolete'
declaration.
---
 lisp/emacs-lisp/advice.el | 2 +-
 lisp/help-fns.el          | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/lisp/emacs-lisp/advice.el b/lisp/emacs-lisp/advice.el
index 3265809f592..7fbdd963e0e 100644
--- a/lisp/emacs-lisp/advice.el
+++ b/lisp/emacs-lisp/advice.el
@@ -3131,7 +3131,7 @@ defadvice
           [DOCSTRING] [INTERACTIVE-FORM]
           BODY...)"
   (declare (doc-string 3) (indent 2)
-           (obsolete "use advice-add or define-advice" "30.1")
+           (obsolete "use `advice-add' or `define-advice'" "30.1")
            (debug (&define name  ;; thing being advised.
                            (name ;; class is [&or "before" "around" "after"
                                  ;;               "activation" "deactivation"]
diff --git a/lisp/help-fns.el b/lisp/help-fns.el
index b34778773a9..e93c535bbef 100644
--- a/lisp/help-fns.el
+++ b/lisp/help-fns.el
@@ -767,7 +767,7 @@ help-fns--obsolete
 	      " is obsolete")
       (when (nth 2 obsolete)
         (insert (format " since %s" (nth 2 obsolete))))
-      (insert (cond ((stringp use) (concat "; " use))
+      (insert (cond ((stringp use) (concat "; " (substitute-quotes use)))
                     (use (format-message "; use `%s' instead." use))
                     (t "."))
               "\n")
-- 
2.42.0

bug#66240: [PATCH] ; Substitute quotes in obsoletion notice in 'C-h f'

[Stefan Kangas]

Version: 30.1

Eshel Yaron via "Bug reports for GNU Emacs, the Swiss army knife of text
editors" <bug-gnu-emacs@gnu.org> writes:

> Before this patch, `C-h f defadvice RET` says:
>
>     This macro is obsolete since 30.1; use advice-add or define-advice
>
> The symbols `advice-add` and `define-advice` are not fontified nor
> buttonized.  With this patch the symbols are quoted like other symbols
> in the *Help* buffer, and, more crucially, they're buttonized.

Thanks, installed on master.

[1: 8a635ac849d]: 2023-09-28 21:44:09 +0200
  ; Substitute quotes in obsoletion notice in 'C-h f'
  https://git.savannah.gnu.org/cgit/emacs.git/commit/?id=8a635ac849d1cc79e0bb3d6cb11b0ff530500a47