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: Sun, 15 Dec 2024 08:38:02 -0500 Message-ID: References: <87zfl0bc7o.fsf@gmail.com> <86frmqwusr.fsf@gnu.org> <86pllutj7a.fsf@gnu.org> <86wmg1sc2h.fsf@gnu.org> Reply-To: Stefan Monnier Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="24359"; 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 Sun Dec 15 14:39:24 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 1tMoqC-00067Q-42 for geb-bug-gnu-emacs@m.gmane-mx.org; Sun, 15 Dec 2024 14:39:24 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tMopw-0000yw-2n; Sun, 15 Dec 2024 08:39:08 -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 1tMops-0000wR-5u for bug-gnu-emacs@gnu.org; Sun, 15 Dec 2024 08:39:04 -0500 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1tMopq-00078s-8H for bug-gnu-emacs@gnu.org; Sun, 15 Dec 2024 08:39:03 -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=34CRln3zypxm+td3v4Dqvq7p6O6C2uRsw7vrb0Te0gI=; b=rHDc16/XXfdQNVcJm0w1LPlnVYql9Bgt+tbnardAJfSxQ0uxuvyfDgUO4ETHsTJvkLZgij0z3WFV17J6mBNxCB4+i9tnfNx8ahiKsS4kAY637MqQriHlRFcj6pX8ta7Sty1Pi4tfM7Hwm5014DuuDWee6KWbtjpCVckErIyi5pXkv1TvJdGSLkwh8St6mijVD6ToNhn5WpF4YRJltRJoHrg7D8Na/ibcUjpVGcPFRm8rcmMarRlWjEj/nnKPOdIGXMmrJJzCvK9/T8g83rNv9fVIRBIwkEjb23/DKv/1+iqO0AMffJZDC9FweIzzrZHRL1zWYcxIMhGj82LbBMs0Gg==; Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1tMopq-0006AR-2z for bug-gnu-emacs@gnu.org; Sun, 15 Dec 2024 08:39:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Stefan Monnier Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 15 Dec 2024 13:39:02 +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.173426990623644 (code B ref 74844); Sun, 15 Dec 2024 13:39:02 +0000 Original-Received: (at 74844) by debbugs.gnu.org; 15 Dec 2024 13:38:26 +0000 Original-Received: from localhost ([127.0.0.1]:49946 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1tMopG-00069H-Bt for submit@debbugs.gnu.org; Sun, 15 Dec 2024 08:38:26 -0500 Original-Received: from mailscanner.iro.umontreal.ca ([132.204.25.50]:20189) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1tMopD-000691-Rx for 74844@debbugs.gnu.org; Sun, 15 Dec 2024 08:38:24 -0500 Original-Received: from pmg2.iro.umontreal.ca (localhost.localdomain [127.0.0.1]) by pmg2.iro.umontreal.ca (Proxmox) with ESMTP id 2139E808F9; Sun, 15 Dec 2024 08:38:12 -0500 (EST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=iro.umontreal.ca; s=mail; t=1734269890; bh=wQr2uZ7WKVALhYdkpCGt/e0fwUiMfsUX6URcwAX5Lxw=; h=From:To:Cc:Subject:In-Reply-To:References:Date:From; b=KMQ1FVL95TGKcwzM8SeyGS9A2SWjgiundT/48B/C7dIoFtHuvcO7CfMunK6NpDbXS 0LFlEUXkN02ZpQDHFtTxhX2MPw4JufsoEPV51jse5UOKCDTM84FunX/46vdhbb1Wyd pYsLTBFh7FgOfGLLHsfKCxxogYhEyRQUyT7OHWtVfYTTYN4fdz97vHFm126eN77Lhn Tkvh1+X61hKgaOTOxJPmlmJBizsgi8jYNFLl2tbLXduRczrqx12C8QZyJyqa3Ddm+g B6ngoX7wf+wHu9J5zb9S8Sxwd/5C/YgEWdbQiIBgQu3IlTzm+cKUMhM4bCtxkspwee UwORd/59NckMA== Original-Received: from mail01.iro.umontreal.ca (unknown [172.31.2.1]) by pmg2.iro.umontreal.ca (Proxmox) with ESMTP id 80B0780038; Sun, 15 Dec 2024 08:38:10 -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 4B13512023C; Sun, 15 Dec 2024 08:38:10 -0500 (EST) In-Reply-To: <86wmg1sc2h.fsf@gnu.org> (Eli Zaretskii's message of "Sun, 15 Dec 2024 08:19:18 +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:297101 Archived-At: >> 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. [ 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. =F0=9F=99=82 ] > In that case, I suggest the following code: > > (dn > (format "* %s: (%s)." dn (or file dn))) > (t (format "* (%s)." file)) Sounds good to me. > That is, the bug in the original code is that they failed to put FILE > in parentheses (and also wanted a premature optimization of producing > the "shortest" entry). This assumes that FILE does not include > parentheses and does not specify a node, i.e. it is NOT in the form > "(FILE)NODE". My reading of ox-texinfo.el is that if that could > happen, the code in org-texinfo-template is already in trouble, > because it is obviously not ready for that. That's right. Stefan