Bug#989029: info: scroll-backward is buggy

[Vincent Lefevre]

Control: forwarded -1 https://sourceforge.net/p/gnuplot/bugs/2575/

On 2022-12-29 02:45:35 +0100, Vincent Lefevre wrote:
> The forward was for the missing terminal types. I have not reported
> this second bug upstream yet.

I've now reported the bug upstream.

-- 
Vincent Lefèvre  - Web: 
100% accessible validated (X)HTML - Blog: 
Work: CR INRIA - computer arithmetic / AriC project (LIP, ENS-Lyon)

Bug#989029: info: scroll-backward is buggy

[Vincent Lefevre]

Control: retitle -1 gnuplot-doc: spurious menu at the end of Section 4 of 
gnuplot.info breaks navigation in info
Control: notforwarded -1

The forward was for the missing terminal types. I have not reported
this second bug upstream yet.

On 2022-12-29 00:51:19 +0100, Vincent Lefevre wrote:
[...]
> This solves the inclusion of the terminal types, but unfortunately,
> the buggy menu is a separate problem. In the gnuplot.info.gz file
> with the patch:
> 
> [...]
> 4.1.54 xlib
> ---
> The 'xlib' terminal driver supports the X11 Windows System.  It
> generates gnuplot_x11 commands, but sends them to the output file
> specified by 'set output '''.  'set term x11' is equivalent to
> 'set output "|gnuplot_x11 -noevents"; set term xlib'.  'xlib' takes the
> same set of options as 'x11'."
> * Menu:
> * Bugs::
> File: gnuplot.info,  Node: Bugs,  Next: Concept_Index,  Prev: Terminal_types, 
>  Up: Top
> 5 Bugs
> **
> [...]
> 
> i.e. the menu is still there, so that going backward from Section 5
> goes to Section 5.2 instead of 4.1.54.

I've attached a patch for this issue: this incorrect menu is added
by 3 lines in doc2texi.el, with the comment

  ; `texinfo-all-menus-update' seems
  ; to miss this one.  how odd.

Perhaps this was added as a workaround to an old bug. With my
patch that removes these 3 lines, the navigation is now correct
(going backward from Section 5 "Bugs" sends to the end of
Section 4 as expected), and I cannot see any new issue.

-- 
Vincent Lefèvre  - Web: 
100% accessible validated (X)HTML - Blog: 
Work: CR INRIA - computer arithmetic / AriC project (LIP, ENS-Lyon)
Description: Do not generate a spurious menu in gnuplot.info.
  A spurious menu with a "Bugs" menu item is generated at the end
  of Section 4 (just before Section 5 "Bugs"). This is incorrect
  and breaks navigation in "info": going backward from Section 5
  sends to Section 5.2 instead of 4.1.54.
Bug-Debian: https://bugs.debian.org/989029
Author: Vincent Lefevre 
Last-Update: 2022-12-29

Index: gnuplot-5.4.4+dfsg1/docs/doc2texi.el
===
--- gnuplot-5.4.4+dfsg1.orig/docs/doc2texi.el
+++ gnuplot-5.4.4+dfsg1/docs/doc2texi.el
@@ -415,9 +415,6 @@ particular conversion chore."
 (search-forward "@node")
 ;; (beginning-of-line)
 ;; (insert "\n\n" d2t-main-menu "\n\n")
-(search-forward "@node Bugs")	; `texinfo-all-menus-update' seems
-(beginning-of-line)			; to miss this one.  how odd.
-(insert "@menu\n* Bugs::\t\t\t\n@end menu\n\n")
 (goto-char (point-max))
 (insert d2t-texi-footer))
   (load-library "texinfo") ;; now do the hard stuff with texinfo-mode

Bug#989029: info: scroll-backward is buggy

[Vincent Lefevre]

Control: unmerge -1
Control: retitle -1 gnuplot-doc: spurious menu at the end of Section 4 breaks 
navigation

On 2022-11-22 15:08:10 +0100, Vincent Lefevre wrote:
> doc2texi.el has
> 
> (defvar d2t-terminal-directory (expand-file-name "../term/")
>   "Location of .trm files in gnuplot source tree.")
> 
> If I understand correctly, this is relative to the build directory
> (since the current working directory is there), while this should have
> been relative to the source directory. A general fix is not obvious:
> one would have to pass $(srcdir) to the file, unless there is some
> Emacs variable that already contains the information. However, for
> Debian, the build directory is at some fixed place in the source tree,
> so that this can be fixed by just adapting the relative path.
> 
> Patch attached.

This solves the inclusion of the terminal types, but unfortunately,
the buggy menu is a separate problem. In the gnuplot.info.gz file
with the patch:

[...]
4.1.54 xlib
---
The 'xlib' terminal driver supports the X11 Windows System.  It
generates gnuplot_x11 commands, but sends them to the output file
specified by 'set output '''.  'set term x11' is equivalent to
'set output "|gnuplot_x11 -noevents"; set term xlib'.  'xlib' takes the
same set of options as 'x11'."
* Menu:
* Bugs::
File: gnuplot.info,  Node: Bugs,  Next: Concept_Index,  Prev: Terminal_types,  
Up: Top
5 Bugs
**
[...]

i.e. the menu is still there, so that going backward from Section 5
goes to Section 5.2 instead of 4.1.54.

-- 
Vincent Lefèvre  - Web: 
100% accessible validated (X)HTML - Blog: 
Work: CR INRIA - computer arithmetic / AriC project (LIP, ENS-Lyon)

Bug#989029: info: scroll-backward is buggy

[Vincent Lefevre]

Control: forwarded -1 https://sourceforge.net/p/gnuplot/bugs/2568/

I've just reported a bug upstream ("with a separate build directory,
the info manual is not built correctly").

-- 
Vincent Lefèvre  - Web: 
100% accessible validated (X)HTML - Blog: 
Work: CR INRIA - computer arithmetic / AriC project (LIP, ENS-Lyon)

Bug#989029: info: scroll-backward is buggy

[Vincent Lefevre]

Control: tags -1 upstream patch

On 2022-11-22 14:46:28 +0100, Vincent Lefevre wrote:
> Removed the upstream tag as I can't reproduce the issue by compiling
> upstream's gnuplot 5.4.5, and Makefile.am and doc2texi.el in docs have
> not changed (and the 5.4.5 release notes don't mention any fix about
> the info manual).

Actually, it *is* an upstream bug. But I can reproduce it only with
a separate build directory (this is what Debian does). I suppose
that the path to the .trm files is incorrect in such a case.

doc2texi.el has

(defvar d2t-terminal-directory (expand-file-name "../term/")
  "Location of .trm files in gnuplot source tree.")

If I understand correctly, this is relative to the build directory
(since the current working directory is there), while this should have
been relative to the source directory. A general fix is not obvious:
one would have to pass $(srcdir) to the file, unless there is some
Emacs variable that already contains the information. However, for
Debian, the build directory is at some fixed place in the source tree,
so that this can be fixed by just adapting the relative path.

Patch attached.

-- 
Vincent Lefèvre  - Web: 
100% accessible validated (X)HTML - Blog: 
Work: CR INRIA - computer arithmetic / AriC project (LIP, ENS-Lyon)
Index: gnuplot-5.4.4+dfsg1/docs/doc2texi.el
===
--- gnuplot-5.4.4+dfsg1.orig/docs/doc2texi.el
+++ gnuplot-5.4.4+dfsg1/docs/doc2texi.el
@@ -116,7 +116,7 @@
 ;;; You may need to customize these variables:
 (defvar d2t-doc-file-name "gnuplot.doc"
   "Name of the gnuplot.doc file.")
-(defvar d2t-terminal-directory (expand-file-name "../term/")
+(defvar d2t-terminal-directory (expand-file-name "../../../term/")
   "Location of .trm files in gnuplot source tree.")
 
 

Bug#989029: info: scroll-backward is buggy

[Vincent Lefevre]

Control: tags -1 - upstream

Removed the upstream tag as I can't reproduce the issue by compiling
upstream's gnuplot 5.4.5, and Makefile.am and doc2texi.el in docs have
not changed (and the 5.4.5 release notes don't mention any fix about
the info manual).

In the gnuplot.info generated using upstream's tarball:

[...]
   Terminals marked 'legacy' are not built by default in recent gnuplot
versions and may not actually work.  @c <3 - all terminal stuff is
pulled from the .trm files

* Menu:

* aifm::
* aqua::
* be::
* epscairo::
[...]

In the gnuplot.info generated using the Debian source package:

[...]
   Terminals marked 'legacy' are not built by default in recent gnuplot
versions and may not actually work.  @c <3 - all terminal stuff is
pulled from the .trm files

* Menu:

* Bugs::

[...]

-- 
Vincent Lefèvre  - Web: 
100% accessible validated (X)HTML - Blog: 
Work: CR INRIA - computer arithmetic / AriC project (LIP, ENS-Lyon)

Bug#989029: info: scroll-backward is buggy

[Vincent Lefevre]

Control: found -1 5.4.1+dfsg1-1
Control: found -1 5.4.4+dfsg1-2
Control: forcemerge -1 989028

On 2022-11-22 13:12:00 +0100, Vincent Lefevre wrote:
> The main issue is actually that the list of terminals is absent
> from the info manual (the HTML and PDF manuals seem OK), which
> makes the info manual *very* incomplete (this part is about 20%
> of the PDF manual) as there are many options specific to
> terminals, which are thus not documented; and in
[...]

and this was bug 989028, which I had reported just before this one.

-- 
Vincent Lefèvre  - Web: 
100% accessible validated (X)HTML - Blog: 
Work: CR INRIA - computer arithmetic / AriC project (LIP, ENS-Lyon)

Bug#989029: info: scroll-backward is buggy

[Vincent Lefevre]

Control: retitle -1 gnuplot-doc: the list of terminals is absent from the info 
manual, also breaking navigation
Control: severity -1 important
Control: tags -1 - wontfix

The wontfix tag had to be removed...

The main issue is actually that the list of terminals is absent
from the info manual (the HTML and PDF manuals seem OK), which
makes the info manual *very* incomplete (this part is about 20%
of the PDF manual) as there are many options specific to
terminals, which are thus not documented; and in

  4.1 complete list of terminals

this list has been replaced by "Bugs::" in the menu, which also
breaks navigation, as explained below.

Moreover, due to the absent list of terminals, the terminal index
is obviously empty.

I suspect a bug in doc2texi.el, which generates the gnuplot.texi
file, from which the info manual is built by texinfo. More
precisely, the inclusion of the .trm files is buggy.

On 2022-11-22 10:34:26 +0100, Hilmar Preuße wrote:
> Control: reassign -1 gnuplot-doc
> 
> Am 24.05.2021 um 01:36 teilte Vincent Lefevre mit:
> 
> Hello,
> 
> as discussed in that bug the issue seems only to occur w/ gnuplot-doc so
> the issue is specific to the gnuplot documentation. Please be so kind to
> have a look at the issue.
> 
> Hilmar
> 
> > The info manual says:
> > 
> >  ('scroll-backward')
> > 
> >   Shift the text in this window down.  The inverse of
> >   'scroll-forward'.  If you are at the start of a node,  takes
> >   you to the "previous" node, so that you can read an entire manual
> >   from finish to start by repeating .  The default scroll size
> >   can be changed by invoking the
> >   ('scroll-backward-page-only-set-window') command with a numeric
> >   argument.
> > [...]
> > 
> > But this doesn't behave like that in the gnuplot manual from the
> > gnuplot-doc 5.4.1+dfsg1-1 Debian package: Go to "Bugs". This gives
> > 
> > 
> > 5 Bugs
> > **
> > 
> > Please e-mail bug reports to the gnuplot-bugs mailing list or upload the
> > report to the gnuplot web site on SourceForge.  Please give complete
> > information on the version of gnuplot you are using and, if possible, a
> > test script that demonstrates the bug.  See 'seeking-assistance'.
> > 
> > * Menu:
> > 
> > * known_limitations::
> > * External_libraries::
> > 
> > 
> > Then do a scroll-backward (with the Backspace or PageUp key).
> > This gives:
> > 
> > 
> > 5.2 External libraries
> > ==
> > [...]
> > 
> > 
> > which is not the "previous" node, but some later node.

The issue comes from the fact that

  4.1 complete list of terminals

has "Bugs::" in the menu, while the "Bugs" node is not a child of
this node ("Bugs" is Section 5, not Section 4.1.x). This is not
supported by "info".

-- 
Vincent Lefèvre  - Web: 
100% accessible validated (X)HTML - Blog: 
Work: CR INRIA - computer arithmetic / AriC project (LIP, ENS-Lyon)

Bug#989029: info: scroll-backward is buggy

[Hilmar Preuße]

Control: reassign -1 gnuplot-doc

Am 24.05.2021 um 01:36 teilte Vincent Lefevre mit:

Hello,

as discussed in that bug the issue seems only to occur w/ gnuplot-doc so
the issue is specific to the gnuplot documentation. Please be so kind to
have a look at the issue.

Hilmar


The info manual says:

 ('scroll-backward')

  Shift the text in this window down.  The inverse of
  'scroll-forward'.  If you are at the start of a node,  takes
  you to the "previous" node, so that you can read an entire manual
  from finish to start by repeating .  The default scroll size
  can be changed by invoking the
  ('scroll-backward-page-only-set-window') command with a numeric
  argument.
[...]

But this doesn't behave like that in the gnuplot manual from the
gnuplot-doc 5.4.1+dfsg1-1 Debian package: Go to "Bugs". This gives


5 Bugs
**

Please e-mail bug reports to the gnuplot-bugs mailing list or upload the
report to the gnuplot web site on SourceForge.  Please give complete
information on the version of gnuplot you are using and, if possible, a
test script that demonstrates the bug.  See 'seeking-assistance'.

* Menu:

* known_limitations::
* External_libraries::


Then do a scroll-backward (with the Backspace or PageUp key).
This gives:


5.2 External libraries
==
[...]


which is not the "previous" node, but some later node.

-- System Information:
Debian Release: 11.0
   APT prefers unstable-debug
   APT policy: (500, 'unstable-debug'), (500, 'testing-security'), (500, 
'stable-updates'), (500, 'unstable'), (500, 'testing'), (500, 'stable'), (1, 
'experimental')
Architecture: amd64 (x86_64)

Kernel: Linux 5.10.0-7-amd64 (SMP w/8 CPU threads)
Kernel taint flags: TAINT_PROPRIETARY_MODULE, TAINT_OOT_MODULE, 
TAINT_UNSIGNED_MODULE
Locale: LANG=POSIX, LC_CTYPE=C.UTF-8 (charmap=UTF-8), LANGUAGE not set
Shell: /bin/sh linked to /bin/dash
Init: systemd (via /run/systemd/system)
LSM: AppArmor: enabled

Versions of packages info depends on:
ii  install-info  6.7.0.dfsg.2-6
ii  libc6 2.31-12
ii  libtinfo6 6.2+20201114-2

info recommends no packages.

info suggests no packages.

-- no debconf information




--
sigfault

Bug#989029: info: scroll-backward is buggy

[Vincent Lefevre]

On 2022-11-20 23:24:37 +0100, Hilmar Preuße wrote:
> As found out the issue is limited to this specific info page and
> probably not a bug in info, but in the info page. I tag the bug as
> wontfix for now.

Perhaps the bug should be reassigned to gnuplot-doc, then.

(However, I think that "info" is poorly designed and could do better.)

-- 
Vincent Lefèvre  - Web: 
100% accessible validated (X)HTML - Blog: 
Work: CR INRIA - computer arithmetic / AriC project (LIP, ENS-Lyon)

Bug#989029: info: scroll-backward is buggy

[Hilmar Preuße]

Control: tags -1 + wontfix

Am 24.05.2021 um 01:36 teilte Vincent Lefevre mit:

Hi,

As found out the issue is limited to this specific info page and
probably not a bug in info, but in the info page. I tag the bug as
wontfix for now.

Hilmar


The info manual says:

 ('scroll-backward')

  Shift the text in this window down.  The inverse of
  'scroll-forward'.  If you are at the start of a node,  takes
  you to the "previous" node, so that you can read an entire manual
  from finish to start by repeating .  The default scroll size
  can be changed by invoking the
  ('scroll-backward-page-only-set-window') command with a numeric
  argument.
[...]



--
sigfault

Bug#989029: info: scroll-backward is buggy

[Vincent Lefevre]

Control: tags -1 upstream

Hi Hilmar,

On 2022-11-11 23:42:12 +0100, Hilmar Preuße wrote:
> They released texinfo 7.0 and I built packages for that version:
> 
> https://freeshell.de/~hille42/texinfo_7.0/
> 
> IMHO this issue is solved in that version. Would be nice if you could
> confirm so I can write a proper changelog.

I had already built the upstream version a few days ago.

zira:~> which info
/home/vinc17/opt/texinfo-7.0/bin/info
zira:~> info --version
info (GNU texinfo) 7.0
[...]

But I still get the same issue on /usr/share/info/gnuplot.info.gz
from gnuplot 5.4.4+dfsg1-2. I've just reported the bug upstream
with a Cc to this bug.

-- 
Vincent Lefèvre  - Web: 
100% accessible validated (X)HTML - Blog: 
Work: CR INRIA - computer arithmetic / AriC project (LIP, ENS-Lyon)

Bug#989029: info: scroll-backward is buggy

[Hilmar Preuße]

Am 24.05.2021 um 01:36 teilte Vincent Lefevre mit:

Hi Vincent,


 ('scroll-backward')

  Shift the text in this window down.  The inverse of
  'scroll-forward'.  If you are at the start of a node,  takes
  you to the "previous" node, so that you can read an entire manual
  from finish to start by repeating .  The default scroll size
  can be changed by invoking the
  ('scroll-backward-page-only-set-window') command with a numeric
  argument.
[...]


They released texinfo 7.0 and I built packages for that version:

https://freeshell.de/~hille42/texinfo_7.0/

IMHO this issue is solved in that version. Would be nice if you could
confirm so I can write a proper changelog.

Thanks,
  Hilmar
--
sigfault

Bug#989029: info: scroll-backward is buggy

[Hilmar Preuße]

Am 24.05.2021 um 01:36 teilte Vincent Lefevre mit:

Hi,


The info manual says:

 ('scroll-backward')

  Shift the text in this window down.  The inverse of
  'scroll-forward'.  If you are at the start of a node,  takes
  you to the "previous" node, so that you can read an entire manual
  from finish to start by repeating .  The default scroll size
  can be changed by invoking the
  ('scroll-backward-page-only-set-window') command with a numeric
  argument.
[...]



Did the situation improve in 6.8?

Hilmar
--
sigfault



OpenPGP_signature
Description: OpenPGP digital signature

Bug#989029: info: scroll-backward is buggy

[Vincent Lefevre]

Package: info
Version: 6.7.0.dfsg.2-6
Severity: normal

The info manual says:

 ('scroll-backward')

 Shift the text in this window down.  The inverse of
 'scroll-forward'.  If you are at the start of a node,  takes
 you to the "previous" node, so that you can read an entire manual
 from finish to start by repeating .  The default scroll size
 can be changed by invoking the
 ('scroll-backward-page-only-set-window') command with a numeric
 argument.
[...]

But this doesn't behave like that in the gnuplot manual from the
gnuplot-doc 5.4.1+dfsg1-1 Debian package: Go to "Bugs". This gives


5 Bugs
**

Please e-mail bug reports to the gnuplot-bugs mailing list or upload the
report to the gnuplot web site on SourceForge.  Please give complete
information on the version of gnuplot you are using and, if possible, a
test script that demonstrates the bug.  See 'seeking-assistance'.

* Menu:

* known_limitations::
* External_libraries::


Then do a scroll-backward (with the Backspace or PageUp key).
This gives:


5.2 External libraries
==
[...]


which is not the "previous" node, but some later node.

-- System Information:
Debian Release: 11.0
  APT prefers unstable-debug
  APT policy: (500, 'unstable-debug'), (500, 'testing-security'), (500, 
'stable-updates'), (500, 'unstable'), (500, 'testing'), (500, 'stable'), (1, 
'experimental')
Architecture: amd64 (x86_64)

Kernel: Linux 5.10.0-7-amd64 (SMP w/8 CPU threads)
Kernel taint flags: TAINT_PROPRIETARY_MODULE, TAINT_OOT_MODULE, 
TAINT_UNSIGNED_MODULE
Locale: LANG=POSIX, LC_CTYPE=C.UTF-8 (charmap=UTF-8), LANGUAGE not set
Shell: /bin/sh linked to /bin/dash
Init: systemd (via /run/systemd/system)
LSM: AppArmor: enabled

Versions of packages info depends on:
ii  install-info  6.7.0.dfsg.2-6
ii  libc6 2.31-12
ii  libtinfo6 6.2+20201114-2

info recommends no packages.

info suggests no packages.

-- no debconf information

-- 
Vincent Lefèvre  - Web: 
100% accessible validated (X)HTML - Blog: 
Work: CR INRIA - computer arithmetic / AriC project (LIP, ENS-Lyon)