unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Stefan Monnier <monnier@iro.umontreal.ca>
Cc: yantar92@posteo.net, 74844@debbugs.gnu.org, suhailsingh247@gmail.com
Subject: bug#74844: m-buffer: Broken Top Directory node in Info manual due to malformed Texinfo direntry
Date: Sun, 15 Dec 2024 16:00:06 +0200	[thread overview]
Message-ID: <86seqpqc61.fsf@gnu.org> (raw)
In-Reply-To: <jwvttb5ul88.fsf-monnier+emacs@gnu.org> (message from Stefan Monnier on Sun, 15 Dec 2024 08:38:02 -0500)

> From: Stefan Monnier <monnier@iro.umontreal.ca>
> Cc: suhailsingh247@gmail.com,  74844@debbugs.gnu.org,  yantar92@posteo.net
> Date: Sun, 15 Dec 2024 08:38:02 -0500
> 
> >> 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.

That's true, but we are discussing what ox-texinfo.el does, or at
least so I thought?  There's no @direntry there, only parts of it
stashes as property lists on some symbols (according to a quick glance
I had at the functions where this code resides).

> [ 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.  🙂  ]

Feel free to take this up with the Texinfo developers.

> > In that case, I suggest the following code:
> >
> >    (dn
> >      (format "* %s: (%s)." dn (or file dn)))
> >    (t (format "* (%s)." file))
> 
> Sounds good to me.

So will you install that?





  reply	other threads:[~2024-12-15 14:00 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-12-13  1:31 bug#74844: 29.4; m-buffer: Broken Top Directory node in Info manual due to malformed Texinfo direntry Suhail Singh
2024-12-13 21:50 ` bug#74844: " Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-12-14  8:08   ` Eli Zaretskii
2024-12-14 13:53     ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-12-14 14:47       ` Eli Zaretskii
2024-12-14 21:05         ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-12-15  6:19           ` Eli Zaretskii
2024-12-15 13:38             ` Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors
2024-12-15 14:00               ` Eli Zaretskii [this message]
2024-12-14 21:48   ` bug#74844: 29.4; " Suhail Singh
2024-12-15  7:17     ` Eli Zaretskii

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=86seqpqc61.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=74844@debbugs.gnu.org \
    --cc=monnier@iro.umontreal.ca \
    --cc=suhailsingh247@gmail.com \
    --cc=yantar92@posteo.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).