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

[Eli Zaretskii]

branch: emacs-26
commit b1aaa72df8e0afd8a849aab7525640f1cec66af3
Author: Eli Zaretskii <address@hidden>
Commit: Eli Zaretskii <address@hidden>

    Improve documentation of Xref
    
    * doc/emacs/maintaining.texi (Looking Up Identifiers): Document
    xref-etags-mode.
---
 doc/emacs/maintaining.texi | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/doc/emacs/maintaining.texi b/doc/emacs/maintaining.texi
index 8f71b12..6ee2f2c 100644
--- a/doc/emacs/maintaining.texi
+++ b/doc/emacs/maintaining.texi
@@ -1812,6 +1812,8 @@ Find definition of identifier, and display it in a new 
frame
 @item M-,
 Go back to where you previously invoked @kbd{M-.} and friends
 (@code{xref-pop-marker-stack}).
address@hidden M-x xref-etags-mode
+Switch @code{xref} to use the @code{etags} backend.
 @end table
 
 @kindex M-.
@@ -1871,6 +1873,18 @@ where you were with @kbd{M-,}.  @kbd{M-,} allows you to 
retrace your
 steps to a depth determined by the variable
 @code{xref-marker-ring-length}, which defaults to 16.
 
address@hidden xref-etags-mode
+  Some major modes install @code{xref} support facilities that might
+fail to find certain identifiers.  For example, in Emacs Lisp mode
+(@pxref{Lisp Eval}) @kbd{M-.} will by default find only functions and
+variables from Lisp packages that are loaded into the current Emacs
+session.  To find more identifiers, 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
address@hidden Tags Table}.)
+
+
 @node Xref Commands
 @subsubsection Commands Available in the @file{*xref*} Buffer
 @cindex commands in @file{*xref*} buffers