From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Stefan Monnier via "Bug reports for GNU Emacs, the Swiss army knife of text editors" Newsgroups: gmane.emacs.bugs Subject: bug#74844: m-buffer: Broken Top Directory node in Info manual due to malformed Texinfo direntry Date: Sat, 14 Dec 2024 16:05:34 -0500 Message-ID: References: <87zfl0bc7o.fsf@gmail.com> <86frmqwusr.fsf@gnu.org> <86pllutj7a.fsf@gnu.org> Reply-To: Stefan Monnier Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="3402"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Cc: yantar92@posteo.net, 74844@debbugs.gnu.org, suhailsingh247@gmail.com To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Sat Dec 14 22:06:31 2024 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1tMZLL-0000j9-5R for geb-bug-gnu-emacs@m.gmane-mx.org; Sat, 14 Dec 2024 22:06:31 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tMZL1-0004HD-4R; Sat, 14 Dec 2024 16:06:13 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tMZKs-0004Gl-4A for bug-gnu-emacs@gnu.org; Sat, 14 Dec 2024 16:06:03 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1tMZKr-0005Wn-ST for bug-gnu-emacs@gnu.org; Sat, 14 Dec 2024 16:06:01 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=debbugs.gnu.org; s=debbugs-gnu-org; h=MIME-Version:Date:References:In-Reply-To:From:To:Subject; bh=23RiXSfLn8KNA511vibJ+jBFVUycyasMnHhX6UWt6nA=; b=RKPjlmz/fKJfWdzuU2QbDmOE3xn+L4gkHx/qMd/TXcH0H39zqrw5/SZEeyz8LLeIMtSkYyTCidg8v3BtcRnpskPuiGAU5rurJ8vDsFNd3z9/UOgD5xdVHlvljWaRRGoFw3BOlcEuw+9myzvLbSWKFY7gAkzTXiAm3sQnSxzH03pvYL5ewIJhLwraYDgKkzYQTR1XDdjHg/R4NikOOuw5GqHNDf0P3zGFJbW5dgpO1mLiCv4OnFI7nG6DcN8cM9eFBxU+fODwNRzhm6wW9HYNyfxZVieRr/78Nac82oQUBWq5E5igNLfc7UFujzPlUvIiwM3zzJgYZGjZnRtHqC+TLQ==; Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1tMZKr-0007wL-ND for bug-gnu-emacs@gnu.org; Sat, 14 Dec 2024 16:06:01 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Stefan Monnier Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 14 Dec 2024 21:06:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 74844 X-GNU-PR-Package: emacs Original-Received: via spool by 74844-submit@debbugs.gnu.org id=B74844.173421035430501 (code B ref 74844); Sat, 14 Dec 2024 21:06:01 +0000 Original-Received: (at 74844) by debbugs.gnu.org; 14 Dec 2024 21:05:54 +0000 Original-Received: from localhost ([127.0.0.1]:48577 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1tMZKj-0007vp-HJ for submit@debbugs.gnu.org; Sat, 14 Dec 2024 16:05:53 -0500 Original-Received: from mailscanner.iro.umontreal.ca ([132.204.25.50]:13649) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1tMZKf-0007vV-K6 for 74844@debbugs.gnu.org; Sat, 14 Dec 2024 16:05:51 -0500 Original-Received: from pmg3.iro.umontreal.ca (localhost [127.0.0.1]) by pmg3.iro.umontreal.ca (Proxmox) with ESMTP id B8751441590; Sat, 14 Dec 2024 16:05:37 -0500 (EST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=iro.umontreal.ca; s=mail; t=1734210336; bh=sZZJe6eqSPWbuEA/nIBex35riepDI1ukOwI/roSgod8=; h=From:To:Cc:Subject:In-Reply-To:References:Date:From; b=TH3FNItRNMeApYtATqhUSSpZGB0tlzAQ/2q/t5+fvImE0eZL5NbQLQqS/dk/TEnUe k4HHLILFZjuz6nUZWKcio3eOIkvHVRxrSY8bkcnyFm9EncA+jroeWLDJ4GbnJA3PdK gbsDj0EFMYTK1vJWtGvoE9QZ2Oa8knO3S1Z+lrfy1yrb4rg/UK+U1cmpIZUQgKvQH+ yLtkcpNOJ0uxrm7COx3YcOU8bhHSgFdnZLRshN2muCvctmmyejliG7vzIdTlypNoCB sptGGSo6WzOr7Ec2igoDXPgjylnJ3XJgqWPzX0prBGVgWEd3Wok5dOap3l69b7+iZY tEB+eTIgxz25A== Original-Received: from mail01.iro.umontreal.ca (unknown [172.31.2.1]) by pmg3.iro.umontreal.ca (Proxmox) with ESMTP id 7C1D8440FB3; Sat, 14 Dec 2024 16:05:36 -0500 (EST) Original-Received: from pastel (104-195-225-43.cpe.teksavvy.com [104.195.225.43]) by mail01.iro.umontreal.ca (Postfix) with ESMTPSA id 4533412016C; Sat, 14 Dec 2024 16:05:36 -0500 (EST) In-Reply-To: <86pllutj7a.fsf@gnu.org> (Eli Zaretskii's message of "Sat, 14 Dec 2024 16:47:37 +0200") X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:297076 Archived-At: >> > An entry in DIR can be either >> > >> > * TITLE: (FILE). DESCRIPTION >> > or >> > * TITLE: (FILE)NODE. DESCRIPTION >> >> [ Side question: Where is this documented? ] > > In the Texinfo manual, in the node "Menu Parts" (since the DIR file is > just a giant menu). That says: A menu entry has three parts, only the second of which is required: The menu entry name (optional). The name of the node (required). A description of the item (optional). It's not clear what "optional" means for the menu entry name: how do we write without it? Does it refer to the * NAME:: syntax described in the next node? BTW, that next node says that `* NAME::` is equivalent to: * NAME: NAME. but shouldn't that be * NAME: (NAME). ? 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. >> > What is 'dn' in the above scheme? And what is 'file'? >> >> `dn` is your TITLE and `file` is your FILE. > > Then I'm not sure this is correct: > > + (t (format "* %s: (%s)." (or dn file) (or file dn)))))) > > What if FILE is nil? My reading of the code says it *may* potentially be nil in some corner case, but I have no idea how that could happen. A nil value for `dn` is normal, in contrast. > Can it be nil at this point? The part in the > parentheses _must_ identify an Info file, with or without a node. It > cannot be the TITLE, because that one can be arbitrary text. If FILE is nil, we're in trouble. IIRC the `(or file dn)` in the code just tried to preserve the previous behavior in the unlikely case that FILE is nil, for lack of understanding about when (or even if) that can happen. Stefan