unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Suhail Singh <suhailsingh247@gmail.com>
To: Stefan Monnier <monnier@iro.umontreal.ca>
Cc: Ihor Radchenko <yantar92@posteo.net>,
	74844@debbugs.gnu.org, Suhail Singh <suhailsingh247@gmail.com>
Subject: bug#74844: 29.4; m-buffer: Broken Top Directory node in Info manual due to malformed Texinfo direntry
Date: Sat, 14 Dec 2024 16:48:01 -0500	[thread overview]
Message-ID: <87cyhuey26.fsf_-_@gmail.com> (raw)
In-Reply-To: <jwvmsgzp8cl.fsf-monnier+emacs@gnu.org> (Stefan Monnier's message of "Fri, 13 Dec 2024 16:50:02 -0500")

Stefan Monnier <monnier@iro.umontreal.ca> writes:

> and to `m-buffer` I pushed another change which tries to workaround
> that bug (for when it's used with an older Emacs).

> modified    m-buffer-doc.org
> @@ -5,7 +5,7 @@
> 
> # FIXME: Shouldn't `ox-texinfo` use sane defaults like the file's name
> #        for TEXINFO_DIR_TITLE and the TITLE for TEXINFO_DIR_DESC?

I believe TEXINFO_DIR_TITLE is obsolete (based on a comment in
ox-texinfo).

> -#+TEXINFO_DIR_TITLE: m-buffer-doc
> +#+TEXINFO_DIR_TITLE: * m-buffer-do: (m-buffer-doc).
                          ^^^^^^^^^^^

Is that a typo, or intentional?  Either m-buffer or m-buffer-doc in that
position would've been more expected.

Btw, based on my interpretation of the Org manual
(info "(org) Texinfo specific export settings"), I would've expected the
below to work:

#+begin_src diff
  -#+TEXINFO_DIR_TITLE: m-buffer-doc
  -#+TEXINFO_DIR_DESC: Manipulate the Contents of Emacs Buffers
  +#+TEXINFO_FILENAME: m-buffer-doc.texi
  +#+TEXINFO_DIR_NAME: m-buffer
#+end_src

With the TEXINFO_DIR_NAME setting being optional, i.e., if omitted the
title of the menu-item would default to m-buffer-doc.  If this doesn't
happen, then there's a bug in ox-texinfo (either in the documentation or
the code).  I am unable to confirm this locally, since it's not clear
what code is run on ELPA to generate the info manual.

-- 
Suhail





  parent reply	other threads:[~2024-12-14 21:48 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
2024-12-14 21:48   ` Suhail Singh [this message]
2024-12-15  7:17     ` bug#74844: 29.4; " 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=87cyhuey26.fsf_-_@gmail.com \
    --to=suhailsingh247@gmail.com \
    --cc=74844@debbugs.gnu.org \
    --cc=monnier@iro.umontreal.ca \
    --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).