bug#42967: 28.0.50; `dired-do-find-regexp' calls internal function `xref--show-xrefs'

bug#42967: 28.0.50; `dired-do-find-regexp' calls internal function `xref--show-xrefs'

[Philipp Stephani]

The function `dired-do-find-regexp' in dired-aux.el contains a call to
the internal function `xref--show-xrefs'.  This should never happen.
Internal functions can change in incompatible ways or even vanish at any
time.  In fact, the signature of `xref--show-xrefs' has changed between
Emacs 26 and 27.  If the functionality of `xref--show-xrefs' is useful
for other libraries, xref.el should grow a proper public function that
then remains stable.


In GNU Emacs 28.0.50 (build 86, x86_64-pc-linux-gnu, GTK+ Version 3.24.20, cairo version 1.16.0)
 of 2020-08-18
Repository revision: 9905001e4b0c9dc0a90cefdd9530a90d07a17b99
Repository branch: master
Windowing system distributor 'The X.Org Foundation', version 11.0.12008000
System Description: Debian GNU/Linux rodete

Recent messages:
For information about GNU Emacs and the GNU system, type C-h C-a.
Source file ‘/home/phst/ThirdParty/emacs/master/lisp/emacs-lisp/rx.el’ newer than byte-compiled file; using older file
Source file ‘/home/phst/ThirdParty/emacs/master/lisp/mail/emacsbug.el’ newer than byte-compiled file; using older file
Source file ‘/home/phst/ThirdParty/emacs/master/lisp/gnus/message.el’ newer than byte-compiled file; using older file

Configured using:
 'configure --enable-gcc-warnings=warn-only
 --enable-gtk-deprecation-warnings --without-pop --with-mailutils
 --enable-checking=all --enable-check-lisp-object-type --with-modules
 'CFLAGS=-O1 -ggdb3 -fno-omit-frame-pointer -fsanitize=address
 -fsanitize=undefined -fsanitize=pointer-compare
 -fsanitize=pointer-subtract''

Configured features:
XPM JPEG TIFF GIF PNG CAIRO SOUND DBUS GSETTINGS GLIB NOTIFY INOTIFY
LIBSELINUX GNUTLS FREETYPE HARFBUZZ ZLIB TOOLKIT_SCROLL_BARS GTK3 X11
XDBE XIM MODULES THREADS LIBSYSTEMD JSON PDUMPER

Important settings:
  value of $LANG: en_US.utf8
  value of $XMODIFIERS: @im=ibus
  locale-coding-system: utf-8-unix

Major mode: Lisp Interaction

Minor modes in effect:
  tooltip-mode: t
  global-eldoc-mode: t
  eldoc-mode: t
  electric-indent-mode: t
  mouse-wheel-mode: t
  tool-bar-mode: t
  menu-bar-mode: t
  file-name-shadow-mode: t
  global-font-lock-mode: t
  font-lock-mode: t
  blink-cursor-mode: t
  auto-composition-mode: t
  auto-encryption-mode: t
  auto-compression-mode: t
  line-number-mode: t
  transient-mark-mode: t

Load-path shadows:
None found.

Features:
(shadow sort mail-extr emacsbug message rmc dired dired-loaddefs rfc822
mml easymenu mml-sec epa epg epg-config gnus-util rmail rmail-loaddefs
text-property-search time-date mm-decode mm-bodies mm-encode mail-parse
rfc2231 mailabbrev gmm-utils mailheader sendmail rfc2047 rfc2045
ietf-drums mm-util mail-prsvr mail-utils phst skeleton derived edmacro
kmacro pcase ffap thingatpt url url-proxy url-privacy url-expand
url-methods url-history url-cookie url-domsuf url-util url-parse
auth-source cl-seq eieio eieio-core cl-macs eieio-loaddefs
password-cache json map url-vars mailcap subr-x rx gnutls puny seq
byte-opt gv bytecomp byte-compile cconv dbus xml compile comint
ansi-color ring cl-loaddefs cl-lib tooltip eldoc electric uniquify
ediff-hook vc-hooks lisp-float-type mwheel term/x-win x-win
term/common-win x-dnd tool-bar dnd fontset image regexp-opt fringe
tabulated-list replace newcomment text-mode elisp-mode lisp-mode
prog-mode register page tab-bar menu-bar rfn-eshadow isearch timer
select scroll-bar mouse jit-lock font-lock syntax facemenu font-core
term/tty-colors frame minibuffer cl-generic cham georgian utf-8-lang
misc-lang vietnamese tibetan thai tai-viet lao korean japanese eucjp-ms
cp51932 hebrew greek romanian slovak czech european ethiopic indian
cyrillic chinese composite charscript charprop case-table epa-hook
jka-cmpr-hook help simple abbrev obarray cl-preloaded nadvice loaddefs
button faces cus-face macroexp files text-properties overlay sha1 md5
base64 format env code-pages mule custom widget hashtable-print-readable
backquote threads dbusbind inotify dynamic-setting system-font-setting
font-render-setting cairo move-toolbar gtk x-toolkit x multi-tty
make-network-process emacs)

Memory information:
((conses 16 68585 4826)
 (symbols 48 8604 1)
 (strings 32 23737 1094)
 (string-bytes 1 766300)
 (vectors 16 13665)
 (vector-slots 8 187558 8778)
 (floats 8 26 32)
 (intervals 56 225 0)
 (buffers 992 11))

-- 
Google Germany GmbH
Erika-Mann-Straße 33
80636 München

Geschäftsführer: Paul Manicle, Halimah DeLaine Prado
Registergericht und -nummer: Hamburg, HRB 86891
Sitz der Gesellschaft: Hamburg

Diese E-Mail ist vertraulich.  Falls Sie diese fälschlicherweise erhalten haben
sollten, leiten Sie diese bitte nicht an jemand anderes weiter, löschen Sie
alle Kopien und Anhänge davon und lassen Sie mich bitte wissen, dass die E-Mail
an die falsche Person gesendet wurde.

This e-mail is confidential.  If you received this communication by mistake,
please don’t forward it to anyone else, please erase all copies and
attachments, and please let me know that it has gone to the wrong person.

bug#42967: 28.0.50; `dired-do-find-regexp' calls internal function `xref--show-xrefs'

[Tino Calancha]

Philipp Stephani <p.stephani2@gmail.com> writes:

> The function `dired-do-find-regexp' in dired-aux.el contains a call to
> the internal function `xref--show-xrefs'.  This should never happen.
> Internal functions can change in incompatible ways or even vanish at any
> time.  In fact, the signature of `xref--show-xrefs' has changed between
> Emacs 26 and 27.  If the functionality of `xref--show-xrefs' is useful
> for other libraries, xref.el should grow a proper public function that
> then remains stable.
I agree.

bug#42967: 28.0.50; `dired-do-find-regexp' calls internal function `xref--show-xrefs'

[Dmitry Gutov]

On 21.08.2020 18:35, Philipp Stephani wrote:

> If the functionality of `xref--show-xrefs' is useful
> for other libraries, xref.el should grow a proper public function that
> then remains stable.

Sure.

 > In fact, the signature of `xref--show-xrefs' has changed between
 > Emacs 26 and 27.

That didn't hurt Dired, though.

In fact, this is about the main advantage to having these features 
developed together: not having to maintain stable boundaries without 
them. They can be changed in tandem.

bug#42967: 28.0.50; `dired-do-find-regexp' calls internal function `xref--show-xrefs'

[Dmitry Gutov]

Sorry,

On 25.08.2020 00:10, Dmitry Gutov wrote:
> In fact, this is about the main advantage to having these features 
> developed together: not having to maintain stable boundaries without 
                                                                ^
                                                                 between
> them. They can be changed in tandem.

bug#42967: 28.0.50; `dired-do-find-regexp' calls internal function `xref--show-xrefs'

[Philipp Stephani]

Am Mo., 24. Aug. 2020 um 23:10 Uhr schrieb Dmitry Gutov <dgutov@yandex.ru>:

>  > In fact, the signature of `xref--show-xrefs' has changed between
>  > Emacs 26 and 27.
>
> That didn't hurt Dired, though.

It does if you upgrade XRef on Emacs 26.3 to the GNU ELPA version.
That's totally possible, and M-x list-package even directly suggests
doing so.

>
> In fact, this is about the main advantage to having these features
> developed together: not having to maintain stable boundaries without
> them. They can be changed in tandem.

They can't if one of them gets released independently and can be
upgraded independently.

bug#42967: 28.0.50; `dired-do-find-regexp' calls internal function `xref--show-xrefs'

[Dmitry Gutov]

On 25.08.2020 10:40, Philipp Stephani wrote:
> Am Mo., 24. Aug. 2020 um 23:10 Uhr schrieb Dmitry Gutov <dgutov@yandex.ru>:
> 
>>   > In fact, the signature of `xref--show-xrefs' has changed between
>>   > Emacs 26 and 27.
>>
>> That didn't hurt Dired, though.
> 
> It does if you upgrade XRef on Emacs 26.3 to the GNU ELPA version.
> That's totally possible, and M-x list-package even directly suggests
> doing so.

Thanks for letting me know. This sounds a lot more urgent than the first 
message of this report.

I'll look into it.

bug#42967: 28.0.50; `dired-do-find-regexp' calls internal function `xref--show-xrefs'

[Dmitry Gutov]

On 26.08.2020 14:27, Dmitry Gutov wrote:
>>> That didn't hurt Dired, though.
>>
>> It does if you upgrade XRef on Emacs 26.3 to the GNU ELPA version.
>> That's totally possible, and M-x list-package even directly suggests
>> doing so.
> 
> Thanks for letting me know. This sounds a lot more urgent than the first 
> message of this report.
> 
> I'll look into it.

Hopefully done now, see xref 1.0.3.

bug#42967: 28.0.50; `dired-do-find-regexp' calls internal function `xref--show-xrefs'

[Philipp Stephani]

Am Do., 27. Aug. 2020 um 00:00 Uhr schrieb Dmitry Gutov <dgutov@yandex.ru>:
>
> On 26.08.2020 14:27, Dmitry Gutov wrote:
> >>> That didn't hurt Dired, though.
> >>
> >> It does if you upgrade XRef on Emacs 26.3 to the GNU ELPA version.
> >> That's totally possible, and M-x list-package even directly suggests
> >> doing so.
> >
> > Thanks for letting me know. This sounds a lot more urgent than the first
> > message of this report.
> >
> > I'll look into it.
>
> Hopefully done now, see xref 1.0.3.

I haven't tested it myself, but dired-aux.el in Emacs 26 contains
(xref--show-xrefs xrefs nil t)
and it looks like the newest xref.el still only accepts 2 arguments.

bug#42967: 28.0.50; `dired-do-find-regexp' calls internal function `xref--show-xrefs'

[Dmitry Gutov]

On 27.08.2020 02:56, Philipp Stephani wrote:
> I haven't tested it myself, but dired-aux.el in Emacs 26 contains
> (xref--show-xrefs xrefs nil t)
> and it looks like the newest xref.el still only accepts 2 arguments.

Thank you, and ouch.

bug#42967: 28.0.50; `dired-do-find-regexp' calls internal function `xref--show-xrefs'

[Lars Ingebrigtsen]

Dmitry Gutov <dgutov@yandex.ru> writes:

>> It does if you upgrade XRef on Emacs 26.3 to the GNU ELPA version.
>> That's totally possible, and M-x list-package even directly suggests
>> doing so.
>
> Thanks for letting me know. This sounds a lot more urgent than the
> first message of this report.

So should a non-private `xref-show-xrefs' function be defined (and used
from dired-aux/project)?  (It could just call `xref--show-xrefs'.)

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

bug#42967: 28.0.50; `dired-do-find-regexp' calls internal function `xref--show-xrefs'

[Dmitry Gutov]

On 07.02.2022 03:13, Lars Ingebrigtsen wrote:
> So should a non-private `xref-show-xrefs' function be defined (and used
> from dired-aux/project)?  (It could just call `xref--show-xrefs'.)

Sure, if we're satisfied with its current capabilities, to "publish" it.

A non-private and (probably) autoloaded.

I'd say rename with an alias, but we should probably drop the unused 
last argument.

There's a potential addition discussed at 
https://github.com/joaotavora/eglot/pull/832, but it could be added at a 
different integration point.

bug#42967: 28.0.50; `dired-do-find-regexp' calls internal function `xref--show-xrefs'

[Lars Ingebrigtsen]

Dmitry Gutov <dgutov@yandex.ru> writes:

> I'd say rename with an alias, but we should probably drop the unused
> last argument.

That's why I thought it might be easier with a new function instead of
an alias...

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

bug#42967: 28.0.50; `dired-do-find-regexp' calls internal function `xref--show-xrefs'

[Dmitry Gutov]

On 07.02.2022 05:46, Lars Ingebrigtsen wrote:
> Dmitry Gutov<dgutov@yandex.ru>  writes:
> 
>> I'd say rename with an alias, but we should probably drop the unused
>> last argument.
> That's why I thought it might be easier with a new function instead of
> an alias...

And this is done now.