bug#28814: [BUMP, PATCH] (26.0.90; When *xref* window is needed, original window-switching intent is lost )

[Eli Zaretskii]

> From: joaotavora@gmail.com (João Távora)
> Cc: dgutov@yandex.ru,  28814@debbugs.gnu.org
> Date: Sat, 28 Oct 2017 20:19:00 +0100
> 
> I hope I fixed everything in these patches.

Thanks, let's get this into the emacs-26 branch, after fixing the
gotchas below.

> diff --git a/etc/NEWS b/etc/NEWS
> index 82778932ab..561a15dbd7 100644
> --- a/etc/NEWS
> +++ b/etc/NEWS
> @@ -1185,6 +1185,16 @@ New user options `term-char-mode-buffer-read-only' and
>  are non-nil by default.  Customize these options to nil if you want
>  the previous behavior.
>  
> +** Xref
> +
> ++++
> +*** When an *xref* buffer is needed, 'TAB' quits and jumps to an xref

Please end this sentence with a period.

> +A new command 'xref-quit-and-goto-xref', bound to 'TAB' in *xref*
> +buffers, quits the window before jumping to the destination. In many
                                                              ^^
Two spaces between sentences, please.

>  (defun xref--show-location (location &optional select)
> +  "Helper for `xref-show-xref' and `xref-goto-xref'.
> +Go to LOCATION and if SELECT is non-nil select its window.  If
> +SELECT is `quit', also quit the *xref* window."

The first line of every doc string should be a single complete
sentence.

> +(defun xref-goto-xref (&optional quit)
> +  "Jump to the xref on the current line and select its window.
> +Non-interactively, non-nil QUIT says to first quit the *xref*
                                   ^^^^
"means", not "says"