From: Suhail Singh <suhailsingh247@gmail.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: yantar92@posteo.net, 74844@debbugs.gnu.org,
Suhail Singh <suhailsingh247@gmail.com>,
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 13:46:32 -0500 [thread overview]
Message-ID: <87v7vkyebb.fsf@gmail.com> (raw)
In-Reply-To: <86frmorejn.fsf@gnu.org> (Eli Zaretskii's message of "Sun, 15 Dec 2024 20:23:24 +0200")
Eli Zaretskii <eliz@gnu.org> writes:
>> > 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.
The decision to rename TEXINFO_DIR_TITLE to TEXINFO_DIR_NAME?
Actually, looking into its history it seems that that particular change
was made by Stefan Monnier in b0c3c90574ed79a63e56acaeee156ef8d9593233
in the org-mode repository.
>> > 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).
I don't understand. The generated Texinfo file will use the
TEXINFO_DIR_DESC keyword as the description if provided. If not, it
uses the TITLE. The TITLE and TEXINFO_DIR_DESC in m-buffer-doc.org are
currently identical. I.e., the generated Texinfo file should be
identical even if TEXINFO_DIR_DESC were to be omitted in
m-buffer-doc.org.
I'm not stating that it should be, only that it could be without causing
any changes. And the only reason I mentioned this is because of the
following comment in m-buffer-doc.org:
#+begin_src org
# FIXME: Shouldn't `ox-texinfo` use sane defaults like the file's name
# for TEXINFO_DIR_TITLE and the TITLE for TEXINFO_DIR_DESC?
#+end_src
If omission of TEXINFO_DIR_DESC results in a variation in the generated
Texinfo file, then perhaps a bug should be opened against ox-texinfo.
--
Suhail
prev parent reply other threads:[~2024-12-15 18:46 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
2024-12-15 18:46 ` Suhail Singh [this message]
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=87v7vkyebb.fsf@gmail.com \
--to=suhailsingh247@gmail.com \
--cc=74844@debbugs.gnu.org \
--cc=eliz@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).