Re: [Emacs-diffs] emacs-26 b1aaa72: Improve documentation of Xref

[Eli Zaretskii]

> From: Dmitry Gutov <address@hidden>
> Date: Mon, 12 Mar 2018 01:15:47 +0200
> 
> I think that's unfair to all the non-etags Xref backends, both built-in and 
> third-party ones.
> 
> "Some ... might fail to find", "to find more indentifiers" imply that etags 
> always has a bigger and more comprehensive index. Which is not entirely true 
> even for the emacs-lisp-mode xref backend. For instance, it will navigate to 
> the functions defined inside any of the ELPA packages the user has installed. 
> For the etags backend to index them, the user has to know to create a tags 
> table there and visit it, which is not something many of users tend to do.

This is not about fairness at all, and I'm surprised, to say the
least, that you judge the text in these terms.

This is about describing a command whose only raison d'être is to
provide a "fire escape" when the default method invoked by M-. fails
to find identifiers, because for some reason they are "out of scope"
for that default method.

> More importantly, I think the Reddit user's problem (which has probably 
> resulted in this manual update) was that they thought, for some reason, that 
> xref-find-definitions will always use the tags table. And that them visiting 
> it should affect what xref-find-definitions finds.

No, I wrote that because it took me some time to find this command,
although I vaguely remembered something like that should be possible.

> So if there's some place in the manual that leaves them with that impression, 
> I think it should be updated.

Feel free to point out such place(s) if you find them.

> Note that even if the current xref backend were using a system that has an 
> all-around more comprehensive index (like GNU Global, or one of the LSP 
> servers, etc), the user would still have a problem if they expected M-x 
> visit-tags-table to update that index.

Irrelevant.  Once again, this command is only for when M-. fails to
find identifiers, something that shouldn't happen with those more
powerful facilities.

> So how about something like this:
> 
>   Some major modes install @code{xref} support facilities that use a
> different index than the current tags table.  For example, in Emacs
> Lisp mode (@pxref{Lisp Eval}) @kbd{M-.} will by default search among the
> functions and variables from Lisp packages that are loaded into the
> current Emacs session.  To consult the tags table instead, turn on the Xref
> Etags minor mode with @address@hidden xref-etags-mode}}.  This command
> forces @code{xref} to use the @code{etags} backend (@pxref{Xref}).
> (For this to work, you should first run @command{etags} to create the
> tags table, see @ref{Create Tags Table}.)

Thanks, but I see no reason to cloud the issue by refraining from
clearly identifying the situation where this command could be useful.
So I changed the text to make it more accurate, in the hope that it
will no longer lend itself to interpretation that prompted your
reaction.