From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.devel Subject: Re: Undocumented elisp_type_hierarchy.{jpg|txt} in info directory. Date: Wed, 03 Apr 2024 14:38:35 +0300 Message-ID: <86wmpe8ymc.fsf@gnu.org> References: <86ttkin96b.fsf@163.com> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="36352"; mail-complaints-to="usenet@ciao.gmane.io" Cc: emacs-devel@gnu.org To: Zhu Zihao Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Wed Apr 03 13:39:55 2024 Return-path: Envelope-to: ged-emacs-devel@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 1rryyA-0009Df-Td for ged-emacs-devel@m.gmane-mx.org; Wed, 03 Apr 2024 13:39:54 +0200 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rryxO-00062g-8M; Wed, 03 Apr 2024 07:39:06 -0400 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 1rryx4-00060J-RU for emacs-devel@gnu.org; Wed, 03 Apr 2024 07:38:47 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rrywy-0000yR-6N; Wed, 03 Apr 2024 07:38:42 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=MIWBnXBQmi3w0A1ewmExGhhm1bnJfFuHLy719IhFLWk=; b=hTPu6J9NAuSu AhCFfnEKaBXL47W8PrHSq8XH4NE73Ldhh/4hie+2aqi9VwmmOqrDwC6u2cHXRbaUrYlfKX3cGwm0j nLcUskbRsJkaB5ViFIYTmkdvMRNhCK0IsPiD/tKYxu0fLpR1PF4aCusfAAB6s01RVXdltz5zTuNoo yvDgf9VuGttbE5bUvjeA4i1uk0Z3tZi5FjUtJRw++tH5z495IAKhnYEf5pL+wsGGaZXI/UAbs/RZK kxgllw8G9GaW02Fg7tbSCoakZTrZx88LvM1foymc7kdKcoA3EKF6zNBpXVYOyPPgXUgLdLhVPFGCC NjVHyoWHm6MWPfFKEuH3eA==; In-Reply-To: <86ttkin96b.fsf@163.com> (message from Zhu Zihao on Wed, 03 Apr 2024 16:13:12 +0800) X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.devel:317481 Archived-At: > From: Zhu Zihao > Date: Wed, 03 Apr 2024 16:13:12 +0800 > > Recently I checked my Emacs installation, and find two file named > elisp_type_hierarchy.{jpg|txt} in share/info directory(these two files > are placed in doc/lispref in source tree). Yes. > According to usual packaging convention, the share/info directory should > only contains compiled texinfo file (use 'info' as extension). It should > not contains txt or jpg (And I believe GNU info or other info reader > will ignore them). This is incorrect. Info manuals can include images, for those Info readers which (like Emacs) are capable of displaying images. See the node "Images" in the Texinfo manual. The stand-alone Info reader, maintained as part of the Texinfo project, cannot display images, so it will display the text replacement instead. If a manual includes images, they are distributed as image files, which should be installed in the same directory tree as the Info files themselves. The simplest arrangement is to have them in the same directory as the Info files. (The Texinfo manual suggests to put them in a subdirectory named 'PACKAGE-figures', but I have yet to see a GNU package that uses such a convention -- they all put images in the same place as the Info files, probably because that allows to avoid hard-coding the subdirectory in the Texinfo sources.) And that is what Emacs does, starting from Emacs 30, which is the first release to have images in its manuals. > One of my friend points me to a commit https://git.savannah.gnu.org/cgit/emacs.git/commit/?id=415604c7a77205d91254a271f0112f69729eb3a9 > In this commit, I found that emacs will use these two files to produce > info file. But IIRC, these source file should not be copied into the > destination of info file, they'll be contained in the compiled info. That is also incorrect. The images should be separate files, since the Info format cannot include the image itself, only a reference to it by its file name. > Can someone tell me that it's purposed to do so, or just unintentional? > thanks! It's definitely intentional, and also correct, see above.