Re: [Emacs-diffs] emacs-25 035bd81: Update documentation for Dired search and replace

Re: [Emacs-diffs] emacs-25 035bd81: Update documentation for Dired search and replace

[Dmitry Gutov]

On 01/23/2016 09:53 AM, Eli Zaretskii wrote:
> branch: emacs-25
> commit 035bd8159fe5bcea15eacc8a23ab54f4bc3b6f17
> Author: Eli Zaretskii <eliz@gnu.org>
> Commit: Eli Zaretskii <eliz@gnu.org>
>
>      Update documentation for Dired search and replace
>
>      * doc/emacs/dired.texi (Operating on Files): Update descriptions
>      of 'A' and 'Q' now bound to 'dired-do-find-regexp' and
>      'dired-do-find-regexp-and-replace'.
>
>      * etc/NEWS: Mention xref-related changes in Dired.

Looks good overall, thanks.

> +(@code{dired-do-find-regexp}).

> +This command is a variant of @code{xref-find-apropos}
> +(@pxref{Identifier Search}), it displays the @file{*xref*} buffer,
> +where you can navigate between matches and display them as needed
> +using the commands described in @ref{Xref Commands}.

That's rather wrong: dired-do-find-regexp performs regexp-search inside 
the files.

xref-find-apropos, on the other hand, performs regexp search inside the 
definitions index (obarray for elisp backend, and TAGS file for etags 
backend).

Although I get that you might want to avoid mentioning 
project-find-regexp here, and there's no other suitable command to 
compare to.

Re: [Emacs-diffs] emacs-25 035bd81: Update documentation for Dired search and replace

[Eli Zaretskii]

> From: Dmitry Gutov <dgutov@yandex.ru>
> Date: Sat, 23 Jan 2016 10:10:12 +0300
> 
> > +This command is a variant of @code{xref-find-apropos}
> > +(@pxref{Identifier Search}), it displays the @file{*xref*} buffer,
> > +where you can navigate between matches and display them as needed
> > +using the commands described in @ref{Xref Commands}.
> 
> That's rather wrong: dired-do-find-regexp performs regexp-search inside 
> the files.
> 
> xref-find-apropos, on the other hand, performs regexp search inside the 
> definitions index (obarray for elisp backend, and TAGS file for etags 
> backend).

Would "similar to" still bug you?

Re: [Emacs-diffs] emacs-25 035bd81: Update documentation for Dired search and replace

[Dmitry Gutov]

On 01/23/2016 11:07 AM, Eli Zaretskii wrote:

> Would "similar to" still bug you?

I think calling it "a variant of" or "similar to" xref-find-references 
instead would be better.

The decision is up to you, it's not too big a problem either way.

I'd just like to add that xref-query-replace works in 
dired-do-find-regexp output, but doesn't work in xref-find-apropos output.

Re: [Emacs-diffs] emacs-25 035bd81: Update documentation for Dired search and replace

[Eli Zaretskii]

> Cc: emacs-devel@gnu.org
> From: Dmitry Gutov <dgutov@yandex.ru>
> Date: Sat, 23 Jan 2016 11:10:35 +0300
> 
> On 01/23/2016 11:07 AM, Eli Zaretskii wrote:
> 
> > Would "similar to" still bug you?
> 
> I think calling it "a variant of" or "similar to" xref-find-references 
> instead would be better.

Done.

> I'd just like to add that xref-query-replace works in 
> dired-do-find-regexp output, but doesn't work in xref-find-apropos output.

Yes, I know.  I decided to disregard that subtlety in this case.