From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Philip Kaludercic Newsgroups: gmane.emacs.devel Subject: Re: (M)Elpa & info/diir files ? Date: Sun, 12 Mar 2023 12:23:41 +0000 Message-ID: <87mt4inooi.fsf@posteo.net> References: Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="31532"; mail-complaints-to="usenet@ciao.gmane.io" Cc: emacs-devel@gnu.org To: David Masterson Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sun Mar 12 13:24:32 2023 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 1pbKkZ-0007zN-R0 for ged-emacs-devel@m.gmane-mx.org; Sun, 12 Mar 2023 13:24:31 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pbKjs-0006Bg-2P; Sun, 12 Mar 2023 08:23:48 -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 1pbKjp-0006B7-Ux for emacs-devel@gnu.org; Sun, 12 Mar 2023 08:23:46 -0400 Original-Received: from mout01.posteo.de ([185.67.36.65]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pbKjn-0004Lh-Pl for emacs-devel@gnu.org; Sun, 12 Mar 2023 08:23:45 -0400 Original-Received: from submission (posteo.de [185.67.36.169]) by mout01.posteo.de (Postfix) with ESMTPS id B955024006B for ; Sun, 12 Mar 2023 13:23:41 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1678623821; bh=hXNkvwZeqhL6M1pMWr/fWZDFCLboyVNzjxh850uDfB4=; h=From:To:Cc:Subject:Date:From; b=Xdp7qmjA+Xr/6GCqRDqInZbN75E27vtPmNZ8Nozecydc48uhn0cnQhy45pDs2pdsL 37YVTHd6NeRMqOiljxlGrTIy2OJc6MAy/DXhb2N5IXmUkVOy1j04yjH0uiQjojksTb 0AJ9IsvNEkmmGM5qWH+ZzRVF9dE5VBXWjAL950WQZ+o8KyhXqRjBY+kObvrDxJkB+X wIXu4rExm5QnsCLj3UsqFlAscI1GKzmq4wloJsw8s0TmQsm4IY2FSjjok8RMR4wiW4 kRl/tktDGocIO0Si2ZAI0RbbpY859Bnf+6BjKDdCbWx4uwsGYqUbeMx1p1FUCbJ4hb BLzRMDbykdO7Q== Original-Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4PZJqK2YkYz9rxG; Sun, 12 Mar 2023 13:23:41 +0100 (CET) In-Reply-To: (David Masterson's message of "Sat, 11 Mar 2023 19:01:35 -0800") Received-SPF: pass client-ip=185.67.36.65; envelope-from=philipk@posteo.net; helo=mout01.posteo.de X-Spam_score_int: -43 X-Spam_score: -4.4 X-Spam_bar: ---- X-Spam_report: (-4.4 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_MED=-2.3, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action 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:304365 Archived-At: David Masterson writes: > In an Emacs package that has a README.org, it's easy to build a Makefile > which generates an .info file for inclusion in the package. However, > does this imply that the .info file must be checked into the git repo > for (M)Elpa to pick it up for inclusion in the package? Is this the > standard? I don't like checking in derivative files unnecessarily. I can only speak for {GNU,NonGNU} ELPA, but no the build system can generate .info files from .org or .texi files (which also means that you don't need to check in .texi files if your manual is written using org-mode and exported using ox-texinfo). But on a different note, I would advise against using the README file as the manual. The README is IMO better suited as a brief explanation of a package with a few pointers than an exhaustive resource. When I want to check out a package using C-h P, I'd rather have the content fit on my screen without having to scroll. -- Philip Kaludercic