bug#68428: 29.1.90; info-xref-tests fails

bug#68428: 29.1.90; info-xref-tests fails

[Michael Albinus via Bug reports for GNU Emacs, the Swiss army knife of text editors]

--8<---------------cut here---------------start------------->8---
# make -C test info-xref-tests
Test info-xref-test-emacs-manuals condition:
    (ert-test-failed
     ((should
       (string-match-p " [0-9]\\{3,\\} good, 0 bad"
		       (buffer-substring-no-properties ... ...)))
      :form
      (string-match-p " [0-9]\\{3,\\} good, 0 bad" "done, 0 good, 0 bad, 0 unavailable")
      :value nil))
   FAILED  1/5  info-xref-test-emacs-manuals (0.266785 sec)
--8<---------------cut here---------------end--------------->8---

I've tried to bisect, but the problem persists back to 2021 (commit
4e77177b06 from  Fri Dec 31 23:17:28 2021 +0000). I didn't try
further. Instead, I suspect that the *.info format has changed
slightly. I'm using

--8<---------------cut here---------------start------------->8---
# makeinfo --version
texi2any (GNU texinfo) 7.0.3
--8<---------------cut here---------------end--------------->8---

Best regards, Michael.


In GNU Emacs 29.1.90 (build 1, x86_64-pc-linux-gnu, GTK+ Version
 3.24.39, cairo version 1.18.0) of 2024-01-13 built on gandalf
Repository revision: 418547162d5273de5a524fe857081867258cd511
Repository branch: emacs-29
Windowing system distributor 'The X.Org Foundation', version 11.0.12302003
System Description: Fedora Linux 39 (Workstation Edition)

Configured features:
ACL CAIRO DBUS FREETYPE GIF GLIB GMP GNUTLS GPM GSETTINGS HARFBUZZ JPEG
LIBOTF LIBSELINUX LIBXML2 M17N_FLT MODULES NOTIFY INOTIFY PDUMPER PNG
RSVG SECCOMP SOUND SQLITE3 THREADS TIFF TOOLKIT_SCROLL_BARS TREE_SITTER
X11 XDBE XIM XINPUT2 XPM GTK3 ZLIB

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

Major mode: Group

Minor modes in effect:
  gnus-undo-mode: t
  display-time-mode: t
  shell-dirtrack-mode: t
  delete-selection-mode: t
  icomplete-mode: t
  global-goto-address-mode: t
  goto-address-mode: t
  tooltip-mode: t
  global-eldoc-mode: t
  show-paren-mode: t
  electric-indent-mode: t
  mouse-wheel-mode: t
  menu-bar-mode: t
  file-name-shadow-mode: t
  global-font-lock-mode: t
  font-lock-mode: t
  blink-cursor-mode: t
  buffer-read-only: t
  column-number-mode: t
  line-number-mode: t
  indent-tabs-mode: t
  transient-mark-mode: t
  auto-composition-mode: t
  auto-encryption-mode: t
  auto-compression-mode: t

Load-path shadows:
/home/albinus/src/elpa/packages/debbugs/debbugs hides /home/albinus/.emacs.d/elpa/debbugs-0.37/debbugs
/home/albinus/src/elpa/packages/debbugs/debbugs-org hides /home/albinus/.emacs.d/elpa/debbugs-0.37/debbugs-org
/home/albinus/src/elpa/packages/debbugs/debbugs-gnu hides /home/albinus/.emacs.d/elpa/debbugs-0.37/debbugs-gnu
/home/albinus/src/elpa/packages/debbugs/debbugs-guix hides /home/albinus/.emacs.d/elpa/debbugs-0.37/debbugs-guix
/home/albinus/src/elpa/packages/debbugs/debbugs-browse hides /home/albinus/.emacs.d/elpa/debbugs-0.37/debbugs-browse
/home/albinus/src/elpa/packages/debbugs/debbugs-pkg hides /home/albinus/.emacs.d/elpa/debbugs-0.37/debbugs-pkg
/home/albinus/src/elpa/packages/debbugs/debbugs-autoloads hides /home/albinus/.emacs.d/elpa/debbugs-0.37/debbugs-autoloads
/home/albinus/src/elpa/packages/debbugs/debbugs-compat hides /home/albinus/.emacs.d/elpa/debbugs-0.37/debbugs-compat
/home/albinus/.emacs.d/elpa/helm-3.9.6/helm-packages hides /home/albinus/.emacs.d/elpa/helm-core-3.9.6/helm-packages
~/lisp/telepathy hides /home/albinus/.emacs.d/elpa/telepathy-20131209.1258/telepathy
/home/albinus/src/elpa/packages/tramp-theme/tramp-theme-autoloads hides /home/albinus/.emacs.d/elpa/tramp-theme-0.2/tramp-theme-autoloads
/home/albinus/src/elpa/packages/tramp-theme/tramp-theme hides /home/albinus/.emacs.d/elpa/tramp-theme-0.2/tramp-theme
/home/albinus/src/elpa/packages/tramp-theme/tramp-theme-pkg hides /home/albinus/.emacs.d/elpa/tramp-theme-0.2/tramp-theme-pkg
/home/albinus/.emacs.d/elpa/hydra-0.15.0/lv hides /home/albinus/.emacs.d/elpa/lv-0.15.0/lv
/home/albinus/.emacs.d/elpa/transient-20231123.2131/transient hides /home/albinus/src/emacs-29/lisp/transient
/home/albinus/src/tramp/lisp/tramp-sh hides /home/albinus/src/emacs-29/lisp/net/tramp-sh
/home/albinus/src/tramp/lisp/tramp-container hides /home/albinus/src/emacs-29/lisp/net/tramp-container
/home/albinus/src/tramp/lisp/tramp-rclone hides /home/albinus/src/emacs-29/lisp/net/tramp-rclone
/home/albinus/src/tramp/lisp/tramp-sudoedit hides /home/albinus/src/emacs-29/lisp/net/tramp-sudoedit
/home/albinus/src/tramp/lisp/tramp-loaddefs hides /home/albinus/src/emacs-29/lisp/net/tramp-loaddefs
/home/albinus/src/tramp/lisp/tramp-cmds hides /home/albinus/src/emacs-29/lisp/net/tramp-cmds
/home/albinus/src/tramp/lisp/tramp-archive hides /home/albinus/src/emacs-29/lisp/net/tramp-archive
~/lisp/dbus hides /home/albinus/src/emacs-29/lisp/net/dbus
/home/albinus/src/tramp/lisp/tramp-smb hides /home/albinus/src/emacs-29/lisp/net/tramp-smb
/home/albinus/src/tramp/lisp/tramp-cache hides /home/albinus/src/emacs-29/lisp/net/tramp-cache
/home/albinus/src/tramp/lisp/tramp-ftp hides /home/albinus/src/emacs-29/lisp/net/tramp-ftp
/home/albinus/src/tramp/lisp/tramp-gvfs hides /home/albinus/src/emacs-29/lisp/net/tramp-gvfs
/home/albinus/src/tramp/lisp/tramp-uu hides /home/albinus/src/emacs-29/lisp/net/tramp-uu
/home/albinus/src/tramp/lisp/tramp-fuse hides /home/albinus/src/emacs-29/lisp/net/tramp-fuse
/home/albinus/src/tramp/lisp/tramp-compat hides /home/albinus/src/emacs-29/lisp/net/tramp-compat
/home/albinus/src/tramp/lisp/trampver hides /home/albinus/src/emacs-29/lisp/net/trampver
/home/albinus/src/tramp/lisp/tramp-sshfs hides /home/albinus/src/emacs-29/lisp/net/tramp-sshfs
/home/albinus/src/tramp/lisp/tramp-integration hides /home/albinus/src/emacs-29/lisp/net/tramp-integration
/home/albinus/src/tramp/lisp/tramp-crypt hides /home/albinus/src/emacs-29/lisp/net/tramp-crypt
/home/albinus/src/tramp/lisp/tramp hides /home/albinus/src/emacs-29/lisp/net/tramp
/home/albinus/src/tramp/lisp/tramp-adb hides /home/albinus/src/emacs-29/lisp/net/tramp-adb

Features:
(shadow sort mail-extr emacsbug cl-extra gnus-ml debbugs-browse
bug-reference disp-table qp pop3 utf-7 nndraft nnmh nnml network-stream
nsm gnus-agent gnus-srvr gnus-score score-mode nnvirtual gnus-msg
gnus-art mm-uu mml2015 mm-view mml-smime smime gnutls dig gnus-cache
gnus-sum shr pixel-fill kinsoku url-file svg dom nnnil smtpmail
gnus-demon nntp gnus-group gnus-undo gnus-start gnus-dbus dbus xml
gnus-cloud nnimap nnmail mail-source utf7 nnoo gnus-spec gnus-int
gnus-range message sendmail yank-media puny rfc822 mml mml-sec epa
derived epg rfc6068 epg-config mm-decode mm-bodies mm-encode mail-parse
rfc2231 rfc2047 rfc2045 ietf-drums mailabbrev gmm-utils mailheader
gnus-win gnus nnheader gnus-util text-property-search mail-utils range
mm-util mail-prsvr face-remap ob-shell ob ob-tangle ol org-src ob-ref
ob-lob ob-table ob-exp ob-comint ob-core org-cycle org-fold
org-fold-core ob-eval org-keys oc org-compat org-version org-macs vc
vc-dispatcher time tramp-sh lxc-tramp lxd-tramp tramp trampver
tramp-integration files-x tramp-message help-mode tramp-compat warnings
xdg shell pcomplete comint ansi-osc ring parse-time iso8601 time-date
format-spec ansi-color tramp-loaddefs rx delsel ido jka-compr icomplete
cus-edit pp cus-load icons wid-edit dired dired-loaddefs goto-addr
thingatpt alert-autoloads android-mode-autoloads
auth-source-gopass-autoloads auth-source-keytar-autoloads
auth-source-kwallet-autoloads auth-source-xoauth2-autoloads
auto-sudoedit-autoloads auto-virtualenv-autoloads
auto-virtualenvwrapper-autoloads boxquote-autoloads
clang-format-autoloads company-shell-autoloads company-autoloads
counsel-toki-autoloads counsel-tramp-autoloads counsel-autoloads
dbus-codegen-autoloads debbugs-autoloads dired-du-autoloads
dired-rsync-autoloads dired-toggle-sudo-autoloads direnv-autoloads
disk-usage-autoloads dockerfile-mode-autoloads ednc-autoloads
el-get-autoloads envrc-autoloads etc-sudoers-mode-autoloads
exec-path-from-shell-autoloads fontaine-autoloads forge-autoloads
closql-autoloads emacsql-autoloads friendly-tramp-path-autoloads
fzf-autoloads ggtags-autoloads ghub-autoloads gited-autoloads
gitlab-ci-mode-flycheck-autoloads gitlab-ci-mode-autoloads
flycheck-autoloads gntp-autoloads gnus-desktop-notify-autoloads
helm-gitlab-autoloads helm-projectile-autoloads helm-autoloads
helm-core-autoloads async-autoloads ibuffer-tramp-autoloads
inheritenv-autoloads ivy-gitlab-autoloads gitlab-autoloads
journalctl-mode-autoloads keepass-mode-autoloads keytar-autoloads
kubernetes-autoloads log4e-autoloads lsp-java-autoloads
dap-mode-autoloads lsp-docker-autoloads bui-autoloads
lsp-treemacs-autoloads lsp-mode-autoloads f-autoloads
lxc-tramp-autoloads lxd-tramp-autoloads magit-filenotify-autoloads
magit-autoloads pcase git-commit-autoloads magit-popup-autoloads
magit-section-autoloads marcopolo-autoloads mastodon-autoloads
nexus-autoloads nnir-est-autoloads oauth2-autoloads
ob-restclient-autoloads orderless-autoloads persist-autoloads
pkg-info-autoloads epl-autoloads popup-autoloads projectile-autoloads
promise-autoloads pylint-autoloads python-environment-autoloads
deferred-autoloads pyvenv-autoloads
recentf-remove-sudo-tramp-prefix-autoloads request-autoloads
restclient-test-autoloads restclient-autoloads s3ed-autoloads finder-inf
slime-autoloads macrostep-autoloads spinner-autoloads
ssh-deploy-autoloads su-autoloads sudo-edit-autoloads sudo-ext-autoloads
sudo-utils-autoloads swiper-autoloads ivy-autoloads sx-autoloads
markdown-mode-autoloads telepathy-autoloads tramp-theme-autoloads
transient-dwim-autoloads transient-autoloads treemacs-autoloads
cfrs-autoloads posframe-autoloads ht-autoloads pfuture-autoloads
ace-window-autoloads avy-autoloads treepy-autoloads uuid-autoloads
vdiff-autoloads hydra-autoloads lv-autoloads vertico-autoloads
virtualenv-autoloads virtualenvwrapper-autoloads s-autoloads
dash-autoloads web-server-autoloads wfnames-autoloads
with-editor-autoloads info compat-autoloads yaml-autoloads
yaml-mode-autoloads package browse-url url url-proxy url-privacy
url-expand url-methods url-history url-cookie generate-lisp-file
url-domsuf url-util mailcap url-handlers url-parse auth-source cl-seq
eieio eieio-core cl-macs password-cache json subr-x map byte-opt gv
bytecomp byte-compile url-vars cl-loaddefs cl-lib rmc iso-transl tooltip
cconv eldoc paren electric uniquify ediff-hook vc-hooks lisp-float-type
elisp-mode 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 lisp-mode prog-mode register page tab-bar menu-bar rfn-eshadow
isearch easymenu timer select scroll-bar mouse jit-lock font-lock syntax
font-core term/tty-colors frame minibuffer nadvice seq simple cl-generic
indonesian philippine 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 emoji-zwj charscript charprop case-table epa-hook
jka-cmpr-hook help abbrev obarray oclosure cl-preloaded button loaddefs
theme-loaddefs faces cus-face macroexp files window text-properties
overlay sha1 md5 base64 format env code-pages mule custom widget keymap
hashtable-print-readable backquote threads dbusbind inotify
dynamic-setting system-font-setting font-render-setting cairo
move-toolbar gtk x-toolkit xinput2 x multi-tty make-network-process
emacs)

Memory information:
((conses 16 242942 29511)
 (symbols 48 22633 0)
 (strings 32 75150 6318)
 (string-bytes 1 2773199)
 (vectors 16 44521)
 (vector-slots 8 1218863 193855)
 (floats 8 252 423)
 (intervals 56 1875 1692)
 (buffers 984 23))

bug#68428: 29.1.90; info-xref-tests fails

[Eli Zaretskii]

> Date: Sat, 13 Jan 2024 17:08:28 +0100
> From:  Michael Albinus via "Bug reports for GNU Emacs,
>  the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
> 
> 
> --8<---------------cut here---------------start------------->8---
> # make -C test info-xref-tests
> Test info-xref-test-emacs-manuals condition:
>     (ert-test-failed
>      ((should
>        (string-match-p " [0-9]\\{3,\\} good, 0 bad"
> 		       (buffer-substring-no-properties ... ...)))
>       :form
>       (string-match-p " [0-9]\\{3,\\} good, 0 bad" "done, 0 good, 0 bad, 0 unavailable")
>       :value nil))
>    FAILED  1/5  info-xref-test-emacs-manuals (0.266785 sec)
> --8<---------------cut here---------------end--------------->8---
> 
> I've tried to bisect, but the problem persists back to 2021 (commit
> 4e77177b06 from  Fri Dec 31 23:17:28 2021 +0000). I didn't try
> further. Instead, I suspect that the *.info format has changed
> slightly.

No, it's a bug introduced by a recent commit, d58d0fa52.  I fixed it
now on the emacs-29 branch.  (Not sure why you saw the problem back in
2021, the bad cross-reference didn't exist then, AFAICT.)

Btw, I have no idea why this test is in the test suite: it basically
tests our manuals, not the code.

bug#68428: 29.1.90; info-xref-tests fails

[Michael Albinus via Bug reports for GNU Emacs, the Swiss army knife of text editors]

Eli Zaretskii <eliz@gnu.org> writes:

Hi Eli,

> No, it's a bug introduced by a recent commit, d58d0fa52.  I fixed it
> now on the emacs-29 branch.

Thanks! It passes now on emba (where I've detected it). But it still
fails in my local environment. I will try to debug it.

> (Not sure why you saw the problem back in 2021, the bad
> cross-reference didn't exist then, AFAICT.)

Don't know. Perhaps I shaould have cleaned up the git repo after every
bisect step, instead calling simply 'make'. And perhaps it is related to
the fact, that it still fails in my local environment.

> Btw, I have no idea why this test is in the test suite: it basically
> tests our manuals, not the code.

It serves its purpose: it has shown a bug introduced recently.

Best regards, Michael.

bug#68428: 29.1.90; info-xref-tests fails

[Eli Zaretskii]

> From: Michael Albinus <michael.albinus@gmx.de>
> Cc: 68428@debbugs.gnu.org
> Date: Sun, 14 Jan 2024 11:25:03 +0100
> 
> Eli Zaretskii <eliz@gnu.org> writes:
> 
> > Btw, I have no idea why this test is in the test suite: it basically
> > tests our manuals, not the code.
> 
> It serves its purpose: it has shown a bug introduced recently.

That's sheer luck: any random Lisp program can sometimes expose a bug,
but that doesn't yet mean it is suitable for the test suite.

bug#68428: 29.1.90; info-xref-tests fails

[Michael Albinus via Bug reports for GNU Emacs, the Swiss army knife of text editors]

[-- Attachment #1: Type: text/plain, Size: 1590 bytes --]

Michael Albinus <michael.albinus@gmx.de> writes:

Hi Eli,

>> No, it's a bug introduced by a recent commit, d58d0fa52.  I fixed it
>> now on the emacs-29 branch.
>
> Thanks! It passes now on emba (where I've detected it). But it still
> fails in my local environment. I will try to debug it.
>
>> (Not sure why you saw the problem back in 2021, the bad
>> cross-reference didn't exist then, AFAICT.)
>
> Don't know. Perhaps I shaould have cleaned up the git repo after every
> bisect step, instead calling simply 'make'. And perhaps it is related to
> the fact, that it still fails in my local environment.

Well, finally it is another bug. It is in function
info-xref-subfile-p. This function tries to determine, whether a given
file is an info subfile.

My emacs-29 branch is checked out in directory /home/albinus/src/emacs-29.
So there is, for example, a call of

(info-xref-subfile-p "/home/albinus/src/emacs-29/info/auth.info")

The function tries to decompose the filename via the regexp
"\\`\\(\\([^-]*-\\)*[^-]*\\)-[0-9]+\\(.*\\)\\'". This succeeds, and
returns

(match-string 1 filename) => "/home/albinus/src/emacs"
(match-string 3 filename) => "/info/auth.info"

This is wrong. string-match should return nil according to the
intention. And the call of

(file-exists-p "/home/albinus/src/emacs/info/auth.info")

succeeds also, because my Emacs master branch is located in
/home/albinus/src/emacs, and therefore
"/home/albinus/src/emacs/info/auth.info" does exist.

The appended patch fixes this. Shall I install it in the emacs-29 or the
master branch?

Best regards, Michael.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: Type: text/x-patch, Size: 962 bytes --]

diff --git a/lisp/info-xref.el b/lisp/info-xref.el
index 7887909037b..95e9a1e55f7 100644
--- a/lisp/info-xref.el
+++ b/lisp/info-xref.el
@@ -79,9 +79,11 @@ info-xref-subfile-p
 which exists, then consider FILENAME a subfile.  This is an
 imperfect test, probably ought to open up the purported top file
 and see what subfiles it says."
-  (and (string-match "\\`\\(\\([^-]*-\\)*[^-]*\\)-[0-9]+\\(.*\\)\\'" filename)
-       (file-exists-p (concat (match-string 1 filename)
-                              (match-string 3 filename)))))
+  (let ((nondir (file-name-nondirectory filename)))
+    (and (string-match "\\`\\(\\([^-]*-\\)*[^-]*\\)-[0-9]+\\(.*\\)\\'" nondir)
+         (file-exists-p (concat (file-name-directory filename)
+                                (match-string 1 nondir)
+                                (match-string 3 nondir))))))

 (defmacro info-xref-with-file (filename &rest body)
   ;; checkdoc-params: (filename body)

bug#68428: 29.1.90; info-xref-tests fails

[Eli Zaretskii]

> From: Michael Albinus <michael.albinus@gmx.de>
> Cc: 68428@debbugs.gnu.org
> Date: Mon, 15 Jan 2024 12:59:03 +0100
> 
> Well, finally it is another bug. It is in function
> info-xref-subfile-p. This function tries to determine, whether a given
> file is an info subfile.
> 
> My emacs-29 branch is checked out in directory /home/albinus/src/emacs-29.
> So there is, for example, a call of
> 
> (info-xref-subfile-p "/home/albinus/src/emacs-29/info/auth.info")
> 
> The function tries to decompose the filename via the regexp
> "\\`\\(\\([^-]*-\\)*[^-]*\\)-[0-9]+\\(.*\\)\\'". This succeeds, and
> returns
> 
> (match-string 1 filename) => "/home/albinus/src/emacs"
> (match-string 3 filename) => "/info/auth.info"
> 
> This is wrong. string-match should return nil according to the
> intention. And the call of
> 
> (file-exists-p "/home/albinus/src/emacs/info/auth.info")
> 
> succeeds also, because my Emacs master branch is located in
> /home/albinus/src/emacs, and therefore
> "/home/albinus/src/emacs/info/auth.info" does exist.

Can you explain why you see the bug and I don't?  What exactly
triggers the bug, and why didn't we uncover it until now?

> The appended patch fixes this. Shall I install it in the emacs-29 or the
> master branch?

On master, please.  But first I'd like to understand the bug better.

Thanks.

bug#68428: 29.1.90; info-xref-tests fails

[Michael Albinus via Bug reports for GNU Emacs, the Swiss army knife of text editors]

Eli Zaretskii <eliz@gnu.org> writes:

Hi Eli,

> Can you explain why you see the bug and I don't?  What exactly
> triggers the bug, and why didn't we uncover it until now?

Because I have in parallel /home/albinus/src/emacs-29/ and /home/albinus/src/emacs/
The problem happens if you run the test inside .../emacs-29/

> Thanks.

Best regards, Michael.

bug#68428: 29.1.90; info-xref-tests fails

[Eli Zaretskii]

> From: Michael Albinus <michael.albinus@gmx.de>
> Cc: 68428@debbugs.gnu.org
> Date: Mon, 15 Jan 2024 14:40:33 +0100
> 
> Eli Zaretskii <eliz@gnu.org> writes:
> 
> Hi Eli,
> 
> > Can you explain why you see the bug and I don't?  What exactly
> > triggers the bug, and why didn't we uncover it until now?
> 
> Because I have in parallel /home/albinus/src/emacs-29/ and /home/albinus/src/emacs/
> The problem happens if you run the test inside .../emacs-29/

OK, thanks.

bug#68428: 29.1.90; info-xref-tests fails

[Michael Albinus via Bug reports for GNU Emacs, the Swiss army knife of text editors]

Eli Zaretskii <eliz@gnu.org> writes:

Hi Eli,

>> > Can you explain why you see the bug and I don't?  What exactly
>> > triggers the bug, and why didn't we uncover it until now?
>>
>> Because I have in parallel /home/albinus/src/emacs-29/ and /home/albinus/src/emacs/
>> The problem happens if you run the test inside .../emacs-29/
>
> OK, thanks.

Pushed to master, closing the bug.

Best regards, Michael.