diff options
| author | Eli Zaretskii | 2018-03-11 19:38:48 +0200 |
|---|---|---|
| committer | Eli Zaretskii | 2018-03-11 19:38:48 +0200 |
| commit | b1aaa72df8e0afd8a849aab7525640f1cec66af3 (patch) | |
| tree | 30089a0d4cab1056aba9a75a280a7f2eb4a41411 | |
| parent | 5c91ca8f30098cb2593ca375daa82d25aef03ad7 (diff) | |
| download | emacs-b1aaa72df8e0afd8a849aab7525640f1cec66af3.tar.gz emacs-b1aaa72df8e0afd8a849aab7525640f1cec66af3.zip | |
Improve documentation of Xref
* doc/emacs/maintaining.texi (Looking Up Identifiers): Document
xref-etags-mode.
| -rw-r--r-- | doc/emacs/maintaining.texi | 14 |
1 files changed, 14 insertions, 0 deletions
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 | |||
| 1812 | @item M-, | 1812 | @item M-, |
| 1813 | Go back to where you previously invoked @kbd{M-.} and friends | 1813 | Go back to where you previously invoked @kbd{M-.} and friends |
| 1814 | (@code{xref-pop-marker-stack}). | 1814 | (@code{xref-pop-marker-stack}). |
| 1815 | @item M-x xref-etags-mode | ||
| 1816 | Switch @code{xref} to use the @code{etags} backend. | ||
| 1815 | @end table | 1817 | @end table |
| 1816 | 1818 | ||
| 1817 | @kindex M-. | 1819 | @kindex M-. |
| @@ -1871,6 +1873,18 @@ where you were with @kbd{M-,}. @kbd{M-,} allows you to retrace your | |||
| 1871 | steps to a depth determined by the variable | 1873 | steps to a depth determined by the variable |
| 1872 | @code{xref-marker-ring-length}, which defaults to 16. | 1874 | @code{xref-marker-ring-length}, which defaults to 16. |
| 1873 | 1875 | ||
| 1876 | @findex xref-etags-mode | ||
| 1877 | Some major modes install @code{xref} support facilities that might | ||
| 1878 | fail to find certain identifiers. For example, in Emacs Lisp mode | ||
| 1879 | (@pxref{Lisp Eval}) @kbd{M-.} will by default find only functions and | ||
| 1880 | variables from Lisp packages that are loaded into the current Emacs | ||
| 1881 | session. To find more identifiers, turn on the Xref Etags minor mode | ||
| 1882 | with @w{@kbd{M-x xref-etags-mode}}. This command forces @code{xref} | ||
| 1883 | to use the @code{etags} backend (@pxref{Xref}). (For this to work, | ||
| 1884 | you should first run @command{etags} to create the tags table, see | ||
| 1885 | @ref{Create Tags Table}.) | ||
| 1886 | |||
| 1887 | |||
| 1874 | @node Xref Commands | 1888 | @node Xref Commands |
| 1875 | @subsubsection Commands Available in the @file{*xref*} Buffer | 1889 | @subsubsection Commands Available in the @file{*xref*} Buffer |
| 1876 | @cindex commands in @file{*xref*} buffers | 1890 | @cindex commands in @file{*xref*} buffers |