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 23:00:05 +0000 Message-ID: <87wn3lmv7u.fsf@posteo.net> References: <87mt4inooi.fsf@posteo.net> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="19696"; 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 Mon Mar 13 00:01:03 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 1pbUgZ-0004uk-3T for ged-emacs-devel@m.gmane-mx.org; Mon, 13 Mar 2023 00:01:03 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pbUfs-0008HX-TT; Sun, 12 Mar 2023 19:00:21 -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 1pbUfl-0008H7-3p for emacs-devel@gnu.org; Sun, 12 Mar 2023 19:00:13 -0400 Original-Received: from mout02.posteo.de ([185.67.36.66]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pbUfg-0006T5-Lg for emacs-devel@gnu.org; Sun, 12 Mar 2023 19:00:11 -0400 Original-Received: from submission (posteo.de [185.67.36.169]) by mout02.posteo.de (Postfix) with ESMTPS id B7E5D2401FE for ; Mon, 13 Mar 2023 00:00:06 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1678662006; bh=+Zn9s0B0qzSyFa8OYvaEKfQEodAwp2Fo3HBmqZUMLLE=; h=From:To:Cc:Subject:Date:From; b=NcBLk0lxsW6U6N4KyLIjYXAMTDHFa2pRHCy6GXd6BDP3noTbbPlNqVdSiUox1I8cT 3ko5j1ht+bUuq6UG/j9CU26qemQ6qwVbEQt0NTKI/OziSQk+FPOtl+qc+fhKPcS01n a4Ke8KQWZKATnnsMaiYeZYfQMEW+35U9EuH2VrIp3nfN8YNo1eYbiW2Vurns3DiJxS znPZggeG3mYLJTDY/IZHTD4bIiBIQCImUh41JUoKqIGd8mHhA02MC4c7RnRtnUVMHE CgqJnQryCfc2V0IspNsBLdhMhA09HJQn0QRg8QITpuqPvhOT5oO/IqhfovGkyjzrym Tio+JDu+pb/lg== Original-Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4PZZxd6wFgz9rxW; Mon, 13 Mar 2023 00:00:05 +0100 (CET) In-Reply-To: (David Masterson's message of "Sun, 12 Mar 2023 13:34:01 -0700") Received-SPF: pass client-ip=185.67.36.66; envelope-from=philipk@posteo.net; helo=mout02.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:304381 Archived-At: David Masterson writes: > Philip Kaludercic writes: > >> 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). > > A few questions: > 1. Does Elpa kick the Makefile in a package? I belive it doesn't do so by default, but it can be told to do so either in the package specification or in the .elpaignore file that you would host in your repository (like a .gitignore). > 2. How does it know what arguments to give Make? Package recipe file? Make will not be invoked by default, that has to be requested in the package specification, where you would also give it the target or targets. FYI, it would be better if one could avoid using this feature, because package-vc from Emacs 29 does not support it (for security reasons). > 3. How does Elpa ensure it is picking up (say) the right Org for org->texi? Again, the package specification indicates what file is the right one to use. You can find out more about the package specification in the ELPA README: https://git.savannah.gnu.org/cgit/emacs/elpa.git/tree/README#n117 > MELPA.org has some documentation in its Github repo. Does ELPA have > similar documentation? If so, where? See above. >> 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. > > Understood. Goal was to get the flow working. Then we can create a > PKG.org file from which a small README.org (or .md) and full PKG.info > can be generated. That would be nice. -- Philip Kaludercic