From: Dmitry Gutov <dgutov@yandex.ru>
To: Arthur Miller <arthur.miller@live.com>
Cc: emacs-devel@gnu.org
Subject: Re: Question about xref and adding "find all references" button to built-in help
Date: Mon, 20 Sep 2021 15:49:43 +0300 [thread overview]
Message-ID: <92c5ea92-accc-5bb8-4063-e37b79fcd264@yandex.ru> (raw)
In-Reply-To: <AM9PR09MB497715ED4F0B19E18473881996A09@AM9PR09MB4977.eurprd09.prod.outlook.com>
On 20.09.2021 08:47, Arthur Miller wrote:
> Dmitry Gutov <dgutov@yandex.ru> writes:
>
>> Hi!
>>
>> On 19.09.2021 23:17, Arthur Miller wrote:
>>> If I would like to add a link as there is one in Helpful, to find all references
>>> for a current symbol in help-mode buffer; which xref functionality should I look
>>> at? Is there a ready made function already, or do I have to write something?
>>
>> We have functionality to searching for references in the current project (also
>> works when inside an Emacs sources checkout) and throughout the load-path.
>
> As extensive as helpful's help-ref? He searches through each and every source
> file found in the load-path. Where do I look, can you give me some pointer I can
> start playing with? Or should I do build my own search?
That's just 'M-x xref-find-references'. Try it in an Elisp buffer.
The implementation is fairly simple: see 'xref-backend-references' in
xref.el and elisp-load-path-roots.
For your own backend, you will probably not dispatch through project.el
method, and use load-path directly combined with package-user-dir. Maybe
after pruning it for entries that reside inside other entries.
>> But you probably want this to work in installed Emacs as well?
>
> What do you mean by "installed Emacs"? Emacs without sources? Sorry, I just woke
> up, have to get that coffein going up :).
Without sources or with compressed sources.
> What about to just have a keyboard shortcuts; say 'R', instead of link. With
> source code displayed it already looks a bit crouded. I think helpfuls buffer
> looks a bit busy with all the links.
>
> I could imagine living with just a shortcut and maybe a context menu item.
I don't really have an opinion on the UI part of this. It can be a
button, command, whatever.
> I attached a screeshots of helpful and built-in help with my yserdays patch both
> showing source code for the comparison.
UI for references and definitions will probably need to be different, no?
next prev parent reply other threads:[~2021-09-20 12:49 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-09-19 20:17 Question about xref and adding "find all references" button to built-in help Arthur Miller
2021-09-19 23:32 ` Dmitry Gutov
2021-09-20 5:47 ` Arthur Miller
2021-09-20 12:49 ` Dmitry Gutov [this message]
2021-09-20 20:52 ` Arthur Miller
2021-09-20 23:37 ` Dmitry Gutov
2021-09-21 10:32 ` Arthur Miller
2021-09-21 14:02 ` Dmitry Gutov
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=92c5ea92-accc-5bb8-4063-e37b79fcd264@yandex.ru \
--to=dgutov@yandex.ru \
--cc=arthur.miller@live.com \
--cc=emacs-devel@gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.