Bug#1027303: gnuplot-doc: The Info manual contains a spurious Texinfo comment "@c <3 [...]"

[Vincent Lefevre]

Package: gnuplot-doc
Version: 5.4.4+dfsg1-2
Severity: minor
Tags: upstream patch
Forwarded: https://sourceforge.net/p/gnuplot/bugs/2576/

The generated Info manual (gnuplot.info) contains a spurious Texinfo
comment "@c <3 - all terminal stuff is pulled from the .trm files" in
Section 4.1 (complete list of terminals).

What happens is that the docs/doc2texi.el converter transforms the
line starting with "<3" into a Texinfo comment by inserting "@c "
at the beginning of the line (function d2t-get-terminals) with the
intent that this line will not appear in the Info manual (as being
a Texinfo comment). However, the input has not been converted to
the Texinfo format yet, so that function d2t-braces-atsigns
(consisting in the first step of the conversion to Texinfo), which
is called later, assumes that "@c" is real text and adds a "@" in
front of it (to escape the "@" since it is regarded as real text).
As a consequence, one gets a line

  @@c <3 -- all terminal stuff is pulled from the .trm files

in the generated Texinfo file gnuplot.texi, and this line will be
rendered as

  @c <3 -- all terminal stuff is pulled from the .trm files

in the Info manual.

I'm attaching a patch that makes doc2texi.el remove this <3 line
instead of attempting to comment it out.

-- System Information:
Debian Release: bookworm/sid
  APT prefers unstable-debug
  APT policy: (500, 'unstable-debug'), (500, 'stable-updates'), (500, 'stable-security'), (500, 'unstable'), (500, 'testing'), (500, 'stable'), (1, 'experimental')
merged-usr: no
Architecture: amd64 (x86_64)

Kernel: Linux 6.0.0-6-amd64 (SMP w/8 CPU threads; PREEMPT)
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

-- no debconf information

-- 
Vincent Lefèvre <vincent at vinc17.net> - Web: <https://www.vinc17.net/>
100% accessible validated (X)HTML - Blog: <https://www.vinc17.net/blog/>
Work: CR INRIA - computer arithmetic / AriC project (LIP, ENS-Lyon)
-------------- next part --------------
A non-text attachment was scrubbed...
Name: gnuplot-texi-comment.patch
Type: text/x-diff
Size: 1548 bytes
Desc: not available
URL: <http://alioth-lists.debian.net/pipermail/debian-science-maintainers/attachments/20221230/9a42ea71/attachment.patch>