From: Eli Zaretskii <eliz@gnu.org>
To: Suhail Singh <suhailsingh247@gmail.com>
Cc: yantar92@posteo.net, 74844@debbugs.gnu.org, monnier@iro.umontreal.ca
Subject: bug#74844: 29.4; m-buffer: Broken Top Directory node in Info manual due to malformed Texinfo direntry
Date: Sun, 15 Dec 2024 20:23:24 +0200 [thread overview]
Message-ID: <86frmorejn.fsf@gnu.org> (raw)
In-Reply-To: <87zfkwygsi.fsf@gmail.com> (message from Suhail Singh on Sun, 15 Dec 2024 12:53:01 -0500)
> From: Suhail Singh <suhailsingh247@gmail.com>
> Cc: Suhail Singh <suhailsingh247@gmail.com>, monnier@iro.umontreal.ca,
> yantar92@posteo.net, 74844@debbugs.gnu.org
> Date: Sun, 15 Dec 2024 12:53:01 -0500
>
> Eli Zaretskii <eliz@gnu.org> writes:
>
> >> 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
> >
> > Why do you suggest removing TEXINFO_DIR_TITLE
>
> Because of this comment in ox-texinfo.el which suggests that it is
> obsolete:
FWIW, I disagree with that decision of Org folks.
> > and TEXINFO_DIR_DESC?
>
> Per (info "(org) Texinfo specific export settings"):
>
> #+begin_quote
> ‘TEXINFO_DIR_DESC’
> The directory description of the document. Defaults to the title
> of the document.
> #+end_quote
>
> The Org document in question already has a TITLE specified.
That there is a default does not mean that we need to discard the
description when we do have it. Discarding it loses important
information (which programs like install-info use).
> > And why is TEXINFO_FILENAME important?
>
> Per (info "(org) Texinfo specific export settings"):
>
> #+begin_quote
> ‘TEXINFO_FILENAME’
> The Texinfo filename.
> #+end_quote
Why is this important?
> Also,
>
> #+begin_quote
> ‘TEXINFO_DIR_NAME’
> The directory name of the document. This is the short name under
> which the ‘m’ command will find your manual in the main Info
> directory. It defaults to the base name of the Texinfo file.
>
> The full form of the Texinfo entry is ‘* DIRNAME: NODE.’ where
> ‘NODE’ is usually just ‘(FILENAME)’. Normally this option only
> provides the ‘DIRNAME’ part, but if you need more control, it can
> also be the full entry (recognized by the presence of parentheses
> or a leading ~* ~).
> #+end_quote
>
> I interpreted "FILENAME" above to mean TEXINFO_FILENAME, which is also
> what's suggested by the code:
>
> #+begin_src emacs-lisp
> (file (or (org-strip-quotes (plist-get info :texinfo-filename))
> (plist-get info :output-file)))
> #+end_src
This is a wrong interpretation. FILENAME here is the Info file name,
not the Texinfo file name (the latter is the file name of the Texinfo
source).
next prev parent reply other threads:[~2024-12-15 18:23 UTC|newest]
Thread overview: 14+ 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 ` bug#74844: 29.4; " Suhail Singh
2024-12-15 7:17 ` Eli Zaretskii
2024-12-15 17:53 ` Suhail Singh
2024-12-15 18:23 ` Eli Zaretskii [this message]
2024-12-15 18:46 ` Suhail Singh
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=86frmorejn.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).