mirror/emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-11-24 07:20:37 +00:00
Code Issues Releases Activity

Improve documentation of Xref

Browse Source 
* doc/emacs/maintaining.texi (Looking Up Identifiers): Document
xref-etags-mode.
This commit is contained in:
Eli Zaretskii 2018-03-11 19:38:48 +02:00
parent 5c91ca8f30
commit b1aaa72df8
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/emacs/maintaining.texi
View File

@ -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