GNU bug report logs - #69462
29.2.50; describe-function should support finding references

Previous Next

Full log

View this message in rfc822 format

From: Dmitry Gutov <dmitry <at> gutov.dev>
To: Spencer Baugh <sbaugh <at> janestreet.com>, 69462 <at> debbugs.gnu.org
Subject: bug#69462: 29.2.50; describe-function should support finding references
Date: Sat, 28 Sep 2024 02:01:30 +0300

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

Hi!

On 28/02/2024 19:31, Spencer Baugh wrote:
> 
> In emacs-lisp-mode in an Emacs git checkout, M-? (xref-find-references)
> nicely searches the load path for references to a symbol.
> 
> It would be neat if this feature could be accessed from
> describe-function and describe-variable as well, perhaps by just hitting
> M-? in the help buffer.
> 
> The feature may need to be redesigned somewhat, since it's currently
> dependent on being run from a project; to use it from a
> describe-function help buffer, we'd want to only search the load-path.

Reusing the Elisp backend seems the easiest approach.

Caveats:

* You need to press RET after M-? like anywhere else (unless 
xref-prompt-for-identifier is customized).
* A bit hackish change in 'xref-backend-definitions'.

Pros:

* Both M-? and M-. work on anything that looks like symbol in the help 
buffer, quoted or not - though there will be false positives like usual.
* Can be similarly added to cl-describe-type.

[help-fns--setup-xref-backend.diff (text/x-patch, attachment)]

Previous Next

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