GNU bug report logs -
#74844
29.4; m-buffer: Broken Top Directory node in Info manual due to malformed Texinfo direntry
Previous Next
Reported by: Suhail Singh <suhailsingh247 <at> gmail.com>
Date: Fri, 13 Dec 2024 01:32:01 UTC
Severity: normal
Found in version 29.4
Fixed in version 0.16.1
Done: "Suhail Singh" <suhailsingh247 <at> gmail.com>
Bug is archived. No further changes may be made.
Full log
Message #32 received at 74844 <at> debbugs.gnu.org (full text, mbox):
>> The manual reads like a "user manual" and I think I need something more
>> like a "reference manual", or a specification, with a precise grammar.
>
> That's because arbitrary programs are not supposed to generate Info
> formats, they are supposed to invoke Texinfo programs to do that. For
> example, to update DIR, you are supposed to invoke install-info, which
> knows about all these rules (and more).
`@direntry` contains text in the Info format and is not generated by
those tools, hence the need for Texinfo *users* to know about that part
of the Info format.
[ Also the Info format is manipulated by enough tools that a reference
manual would not be amiss, even if it's used only "internally" by all
these tools. 🙂 ]
> In that case, I suggest the following code:
>
> (dn
> (format "* %s: (%s)." dn (or file dn)))
> (t (format "* (%s)." file))
Sounds good to me.
> That is, the bug in the original code is that they failed to put FILE
> in parentheses (and also wanted a premature optimization of producing
> the "shortest" entry). This assumes that FILE does not include
> parentheses and does not specify a node, i.e. it is NOT in the form
> "(FILE)NODE". My reading of ox-texinfo.el is that if that could
> happen, the code in org-texinfo-template is already in trouble,
> because it is obviously not ready for that.
That's right.
Stefan
This bug report was last modified 141 days ago.
Previous Next
GNU bug tracking system
Copyright (C) 1999 Darren O. Benham,
1997,2003 nCipher Corporation Ltd,
1994-97 Ian Jackson.