GNU bug report logs - #6304
23.2; advising yank

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 6304 in the body.
You can then email your comments to 6304 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Leo <sdl.web <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 23.2; advising yank
Date: Sat, 29 May 2010 21:03:09 +0100

I have been seeing this for a while but just find this reproducible
case:

1. (defadvice yank (after random-advice activate)
      (message "hello world"))

2. C-h f yank RET

The string "This function is advised." is not highlighted with the
warning face.

In GNU Emacs 23.2.5 (x86_64-apple-darwin10.3.0)
 of 2010-05-28

Leo

Message #8 received at 6304 <at> debbugs.gnu.org (full text, mbox):

From: bojohan <at> gnu.org (Johan Bockgård)
To: Leo <sdl.web <at> gmail.com>
Cc: 6304 <at> debbugs.gnu.org
Subject: Re: bug#6304: 23.2; advising yank
Date: Sun, 30 May 2010 02:22:18 +0200

Leo <sdl.web <at> gmail.com> writes:

> 1. (defadvice yank (after random-advice activate)
>       (message "hello world"))
>
> 2. C-h f yank RET
>
> The string "This function is advised." is not highlighted with the
> warning face.

The highlighting is removed by substitute-command-keys:

    Returns original STRING if no substitutions were made. Otherwise, a
    new string, without any text properties, is returned.

Message #11 received at 6304 <at> debbugs.gnu.org (full text, mbox):

From: Leo <sdl.web <at> gmail.com>
To: Johan Bockgård <bojohan <at> gnu.org>
Cc: 6304 <at> debbugs.gnu.org
Subject: Re: bug#6304: 23.2; advising yank
Date: Sun, 30 May 2010 06:57:00 +0100

On 30 May 2010 01:22, Johan Bockgård <bojohan <at> gnu.org> wrote:
> The highlighting is removed by substitute-command-keys:
>
>    Returns original STRING if no substitutions were made. Otherwise, a
>    new string, without any text properties, is returned.

That explains a lot.

Looks like an oversight/bug on substitute-command-keys. The new
additional doc-string from advice was added quite recently.

Thanks.

Leo

Message #14 received at 6304 <at> debbugs.gnu.org (full text, mbox):

From: Leo <sdl.web <at> gmail.com>
To: 6304 <at> debbugs.gnu.org
Cc: Johan Bockgård <bojohan <at> gnu.org>
Subject: Re: 23.2; [PATCH] advising yank
Date: Sat, 22 Jan 2011 11:50:37 +0800

From 238f221401cbdafe1df6634cbb69480e2748cced Mon Sep 17 00:00:00 2001
Date: Sat, 22 Jan 2011 11:40:15 +0800
Subject: [PATCH] Fix bug #6304

The text property in the documentation string may be removed by
substitute-command-keys.
---
 lisp/emacs-lisp/advice.el |    4 +---
 lisp/help-mode.el         |    7 +++++++
 2 files changed, 8 insertions(+), 3 deletions(-)

diff --git a/lisp/emacs-lisp/advice.el b/lisp/emacs-lisp/advice.el
index 9267bc8a..02696d9e 100644
--- a/lisp/emacs-lisp/advice.el
+++ b/lisp/emacs-lisp/advice.el
@@ -3007,9 +3007,7 @@ (defun ad-make-advised-docstring (function &optional style)
     (setq usage (if (null usage) t (setq origdoc (cdr usage)) (car usage)))
     (if origdoc (setq paragraphs (list origdoc)))
     (unless (eq style 'plain)
-      (push (propertize (concat "This " origtype " is advised.")
-			'face 'font-lock-warning-face)
-	    paragraphs))
+      (push (concat "This " origtype " is advised.") paragraphs))
     (ad-dolist (class ad-advice-classes)
       (ad-dolist (advice (ad-get-enabled-advices function class))
 	(setq advice-docstring
diff --git a/lisp/help-mode.el b/lisp/help-mode.el
index f115e425..14ff164e 100644
--- a/lisp/help-mode.el
+++ b/lisp/help-mode.el
@@ -302,6 +302,13 @@ (defun help-mode-finish ()
     ;; View mode's read-only status of existing *Help* buffer is lost
     ;; by with-output-to-temp-buffer.
     (toggle-read-only 1)
+    (save-excursion
+      (goto-char (point-min))
+      (let ((inhibit-read-only t))
+	(when (re-search-forward "^This \\w+ is advised.$" nil t)
+	  (put-text-property (match-beginning 0)
+			     (match-end 0)
+			     'face 'font-lock-warning-face))))
     (help-make-xrefs (current-buffer))))
 
 ;; Grokking cross-reference information in doc strings and
-- 
1.7.4.rc1

Message #17 received at 6304 <at> debbugs.gnu.org (full text, mbox):

From: Chong Yidong <cyd <at> stupidchicken.com>
To: Leo <sdl.web <at> gmail.com>
Cc: 6304 <at> debbugs.gnu.org, Johan Bockgård <bojohan <at> gnu.org>
Subject: Re: bug#6304: 23.2; [PATCH] advising yank
Date: Fri, 28 Jan 2011 16:42:21 -0500

Leo <sdl.web <at> gmail.com> writes:

> From 238f221401cbdafe1df6634cbb69480e2748cced Mon Sep 17 00:00:00 2001
> Date: Sat, 22 Jan 2011 11:40:15 +0800
> Subject: [PATCH] Fix bug #6304
>
> The text property in the documentation string may be removed by
> substitute-command-keys.

Committed, thanks.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.