mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-15 10:30:25 -08:00
Code Issues Projects Releases Wiki Activity

Improve documentation of new Xref options

Browse source 
* lisp/progmodes/xref.el (xref-auto-jump-to-first-definition)
(xref-auto-jump-to-first-xref): More accurate description in the
doc strings.

* doc/emacs/maintaining.texi (Looking Up Identifiers)
(Identifier Search, List Identifiers, Project File Commands): Fix
the documentation of 'xref-auto-jump-to-first-definition' and
'xref-auto-jump-to-first-xref' to be more accurate.

* etc/NEWS: More accurate wording of the entry about
'xref-auto-jump-to-first-definition' and
'xref-auto-jump-to-first-xref'.
This commit is contained in:
Eli Zaretskii 2021-09-07 16:03:27 +03:00
parent d5c6bf9625
commit b02c9bcceb
3 changed files with 45 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

13
lisp/progmodes/xref.el
View file

@ -420,7 +420,9 @@ elements is negated: these commands will NOT prompt."
"If t, `xref-find-definitions' always jumps to the first result.
`show' means to show the first result's location, but keep the
focus on the Xref buffer's window.
`move' means to only move point to the first result."
`move' means to only move point to the first result.
This variable also affects commands similar to `xref-find-definitions',
such as `xref-find-definitions-other-window'."
:type '(choice (const :tag "Jump" t)
(const :tag "Show" show)
(const :tag "Move point only" move)
@ -429,13 +431,16 @@ focus on the Xref buffer's window.
:package-version '(xref . "1.2.0"))
(defcustom xref-auto-jump-to-first-xref nil
"If t, xref commands always jump to the first result.
"If t, `xref-find-references' always jumps to the first result.
`show' means to show the first result's location, but keep the
focus on the Xref buffer's window.
`move' means to only move point to the first result.
This variable also affects commands similar to `xref-find-definitions',
such as `xref-find-references-at-mouse', `xref-find-apropos',
and `project-find-regexp'.
Please be careful changing this value if you are using Emacs 27
or earlier: it can break dired-do-find-regexp-and-replace."
Please be careful when changing the value if you are using Emacs 27
or earlier: it can break `dired-do-find-regexp-and-replace'."
:type '(choice (const :tag "Jump" t)
(const :tag "Show" show)
(const :tag "Move point only" move)