From: Eli Zaretskii <eliz@gnu.org>
Date: Sun, 11 Mar 2018 17:38:48 +0000 (+0200)
Subject: Improve documentation of Xref
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=7f35e7dd65a0ca4e399f223b01735b750d262395;p=emacs.git

Improve documentation of Xref

* doc/emacs/maintaining.texi (Looking Up Identifiers): Document
xref-etags-mode.
---

diff --git a/doc/emacs/maintaining.texi b/doc/emacs/maintaining.texi
index 8f71b12b81f..6ee2f2cc597 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}).
+@item 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.
 
+@findex 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 @w{@kbd{M-x 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}.)
+
+
 @node Xref Commands
 @subsubsection Commands Available in the @file{*xref*} Buffer
 @cindex commands in @file{*xref*} buffers