GNU bug report logs - #74727
[PATCH] ; * lisp/apropos.el (apropos-library): Fix typo.

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 74727 in the body.
You can then email your comments to 74727 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: Eshel Yaron <me <at> eshelyaron.com>
To: bug-gnu-emacs <at> gnu.org
Subject: [PATCH] ; * lisp/apropos.el (apropos-library): Fix typo.
Date: Sat, 07 Dec 2024 14:31:53 +0100

[Message part 1 (text/plain, inline)]

Tags: patch

This patch fixes the issue described below, which IIUC originates in a
mere typo in commit 671862f6b3089c3a503c1b6936a821ad54429359

1. emacs -Q
2. M-x apropos-library elisp-mode RET
3. The *Apropos* buffer incorrectly lists methods that elisp-mode.el
   defines as if they were _features_ provided by the library.
   Accordingly, clicking on one of those references yields an error such
   as "Unknown library `xref-backend-definitions'"

[0001-lisp-apropos.el-apropos-library-Fix-typo.patch (text/patch, attachment)]

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

From: Dmitry Gutov <dmitry <at> gutov.dev>
To: Eshel Yaron <me <at> eshelyaron.com>, 74727 <at> debbugs.gnu.org
Subject: Re: bug#74727: [PATCH] ; * lisp/apropos.el (apropos-library): Fix
 typo.
Date: Sun, 8 Dec 2024 03:54:19 +0200

Hi Eshel,

On 07/12/2024 15:31, Eshel Yaron wrote:
> This patch fixes the issue described below, which IIUC originates in a
> mere typo in commit 671862f6b3089c3a503c1b6936a821ad54429359
> 
> 1. emacs -Q
> 2. M-x apropos-library elisp-mode RET
> 3. The*Apropos* buffer incorrectly lists methods that elisp-mode.el
>     defines as if they were_features_ provided by the library.
>     Accordingly, clicking on one of those references yields an error such
>     as "Unknown library `xref-backend-definitions'"

Thanks! That's a good suggestion.

If you've started testing this area, though, do you know of a case when 
dropping this case - like:

diff --git a/lisp/apropos.el b/lisp/apropos.el
index 0655fecd0e8..9af8a7269ae 100644
--- a/lisp/apropos.el
+++ b/lisp/apropos.el
@@ -733,7 +733,7 @@ apropos-library
         ('t nil)                     ; Skip "was an autoload" entries.
         ;; FIXME: Print information about each individual method: both
         ;; its docstring and specializers (bug#21422).
-        ('cl-defmethod (push (cadr x) provides))
+        ;; ('cl-defmethod (push (cadr x) provides))
         ;; FIXME: Add extension point (bug#72616).
 	(_ (let ((sym (or (cdr-safe x) x)))
 	     (and sym (symbolp sym)


...does not work just as well?

From what I see now, any 'cl-defmethod' entry in load-history is 
accompanied by a 'defun' entry anyway. And the original report 
(https://debbugs.gnu.org/21422) was about an error being raised, but I 
can't reproduce it now after commenting this line out.

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

From: Eshel Yaron <me <at> eshelyaron.com>
To: Dmitry Gutov <dmitry <at> gutov.dev>
Cc: 74727 <at> debbugs.gnu.org
Subject: Re: bug#74727: [PATCH] ; * lisp/apropos.el (apropos-library): Fix
 typo.
Date: Sun, 08 Dec 2024 17:37:14 +0100

Dmitry Gutov <dmitry <at> gutov.dev> writes:

> Hi Eshel,
>
> On 07/12/2024 15:31, Eshel Yaron wrote:
>> This patch fixes the issue described below, which IIUC originates in a
>> mere typo in commit 671862f6b3089c3a503c1b6936a821ad54429359
>> 
>> 1. emacs -Q
>> 2. M-x apropos-library elisp-mode RET
>> 3. The*Apropos* buffer incorrectly lists methods that elisp-mode.el
>>     defines as if they were_features_ provided by the library.
>>     Accordingly, clicking on one of those references yields an error such
>>     as "Unknown library `xref-backend-definitions'"
>
> Thanks! That's a good suggestion.
>
> If you've started testing this area, though, do you know of a case when 
> dropping this case - like:
>
> diff --git a/lisp/apropos.el b/lisp/apropos.el
> index 0655fecd0e8..9af8a7269ae 100644
> --- a/lisp/apropos.el
> +++ b/lisp/apropos.el
> @@ -733,7 +733,7 @@ apropos-library
>           ('t nil)                     ; Skip "was an autoload" entries.
>           ;; FIXME: Print information about each individual method: both
>           ;; its docstring and specializers (bug#21422).
> -        ('cl-defmethod (push (cadr x) provides))
> +        ;; ('cl-defmethod (push (cadr x) provides))
>           ;; FIXME: Add extension point (bug#72616).
>   	(_ (let ((sym (or (cdr-safe x) x)))
>   	     (and sym (symbolp sym)
>
> ...does not work just as well?

Yes, that seems to work too, and it doesn't produce duplicate entries
for these definitions, so that's even better :)

>  From what I see now, any 'cl-defmethod' entry in load-history is 
> accompanied by a 'defun' entry anyway. And the original report 
> (https://debbugs.gnu.org/21422) was about an error being raised, but I 
> can't reproduce it now after commenting this line out.

Same here.


Eshel

Message #16 received at 74727-done <at> debbugs.gnu.org (full text, mbox):

From: Dmitry Gutov <dmitry <at> gutov.dev>
To: Eshel Yaron <me <at> eshelyaron.com>
Cc: 74727-done <at> debbugs.gnu.org
Subject: Re: bug#74727: [PATCH] ; * lisp/apropos.el (apropos-library): Fix
 typo.
Date: Tue, 10 Dec 2024 03:41:43 +0200

Version: 31.1

On 08/12/2024 18:37, Eshel Yaron wrote:
> Yes, that seems to work too, and it doesn't produce duplicate entries
> for these definitions, so that's even better 🙂
> 
>>   From what I see now, any 'cl-defmethod' entry in load-history is
>> accompanied by a 'defun' entry anyway. And the original report
>> (https://debbugs.gnu.org/21422) was about an error being raised, but I
>> can't reproduce it now after commenting this line out.
> Same here.

Thanks for verifying! Pushed to master and closing.

Previous Next

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