From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: David Masterson Newsgroups: gmane.emacs.devel Subject: Re: (M)Elpa & info/diir files ? Date: Sun, 12 Mar 2023 13:34:01 -0700 Message-ID: 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="4218"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.1 (gnu/linux) Cc: emacs-devel@gnu.org To: Philip Kaludercic Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Mon Mar 13 04:20:43 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 1pbYjp-0000rt-HP for ged-emacs-devel@m.gmane-mx.org; Mon, 13 Mar 2023 04:20:41 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pbYjG-0000f9-Eq; Sun, 12 Mar 2023 23:20: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 1pbSTH-00041w-KL for emacs-devel@gnu.org; Sun, 12 Mar 2023 16:39:11 -0400 Original-Received: from mail-dm6nam10olkn2082e.outbound.protection.outlook.com ([2a01:111:f400:7e88::82e] helo=NAM10-DM6-obe.outbound.protection.outlook.com) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pbSTF-0002lu-St for emacs-devel@gnu.org; Sun, 12 Mar 2023 16:39:11 -0400 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=Ip4TjpObxaoDTQzOYzrlvI/sMHT908kpC0DWbY58Gu0/ytlFIk2Lw66T7v2Ghv5p8vZ34G7UrcgIstW0Pryfwpt1lTnE1d246cQYlZhZVncerPt+DCoDDeZRnF6buyPflKX8MbgiEtjCloRzihuam04J5TA7ksiCli+OcmXL/XiKvMRXLsnDL6wg1nz0wxP9iyAX6sdl7SwQi4OdUqSfehrXDSu+4+c5X55gWvbBDweLtcafSv1Z87BM2RoZHHWZPLpm+/s0r4jm53DYcCnADjINrCRiEOJx/TWMaHkTPseptGiWz8kzsxlXWn8+1jgySaCSsvg01+/IFNmpPcbWnA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=Wr/M6/h0ahcf5QNVvR5XuthHxojfjIdvXgGk8TiNe7I=; b=S/4oYLShWI5UqxKyo91dyT9DClKsW5ciXH/4JghUKaBN8T7FJjSAZfDIunkdiIXRyz1Nuaulebemjd3lHbpWSnnRatLt9VWPc9PVHF6/XgiXk37Ez30+/8ji8W61lxuC2Hezh7H0uhEf4i5tm3OLipQaVQLjuSF9nTeL9sIA1jHdBgaflYFCP6hKNQ7IpgCSFzh2zIFd7mhVSpsQf+gWUU/2fgIyu8fHGQhBgyLaL2Sq5WIujbJuabz5UEwOLbwW5GB3GVenQ5Zn+Pzs4fO9z4MRWVRlmMlgARfisMQ8CfhWPtrPduliKvJzUDYpEEdKI6Bm8qiu34wp+rbx3Yy3Aw== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=none; dmarc=none; dkim=none; arc=none DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=outlook.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=Wr/M6/h0ahcf5QNVvR5XuthHxojfjIdvXgGk8TiNe7I=; b=UVTCSGZHt1xBlak7XP3AMVrhsrtl1YZAH1PBcJU5mEzfvh1ECfQVdzSHWT9LdHzfxw5V7EzC9Zc4zM1gisRPMRQNstkLusbR83osoGHFAqWkAob3IfbdH41Bc7OoZN+b+EXf48W0nrQPUiPR4SXJiT4zPwT5W7W3w4ZURSoIlFIxyCFZQKJTepDGZiB4Utc7PFYMi+oOfeHEYZ80BYHmm7pLY2luJDhLQQvyvoPeg2nAg25mmX5T7WEvAFUetxGrbiLX+x/jCf+VOlMbElWUkf4Sx03YBhVfNZWeuBvHNE27m2fvYVTTYPrnrmgNeEcm5RLmP6/qA1NYJZwvgbD6hQ== Original-Received: from SJ0PR03MB5455.namprd03.prod.outlook.com (2603:10b6:a03:27b::11) by DM4PR03MB6061.namprd03.prod.outlook.com (2603:10b6:5:390::21) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6178.24; Sun, 12 Mar 2023 20:34:03 +0000 Original-Received: from SJ0PR03MB5455.namprd03.prod.outlook.com ([fe80::af6e:9e2b:93a1:3d0b]) by SJ0PR03MB5455.namprd03.prod.outlook.com ([fe80::af6e:9e2b:93a1:3d0b%6]) with mapi id 15.20.6178.024; Sun, 12 Mar 2023 20:34:03 +0000 In-Reply-To: <87mt4inooi.fsf@posteo.net> (Philip Kaludercic's message of "Sun, 12 Mar 2023 12:23:41 +0000") X-TMN: [ByA7y8o/wVZWUL8UYqA+SMy3IVg0IPyXtZAkcXFVKiNCVQ5G9JmatMgbgqH6ucr6] X-ClientProxiedBy: PH0PR07CA0091.namprd07.prod.outlook.com (2603:10b6:510:4::6) To SJ0PR03MB5455.namprd03.prod.outlook.com (2603:10b6:a03:27b::11) X-Microsoft-Original-Message-ID: <878rg11zgm.fsf@penguin> X-MS-Exchange-MessageSentRepresentingType: 2 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: SJ0PR03MB5455:EE_|DM4PR03MB6061:EE_ X-MS-Office365-Filtering-Correlation-Id: 11d60fbb-aa77-457e-11a1-08db23391e7e X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: BSi5TrZPd6ayjgWCUr62H0JOpI2MEqdgY+Kb74NBkVQ4INzbPIf/NCecwPcbZd+gT9aE7gQz6vVEkoCgdZBSoogAp/Tupi+5GiqJC+ViGUwHh/4Ms/lUtqagLa1H0WhEEsNKGnboqXmJt3Xn2D4Sc7UIR3yOqUSGf05PULovfqQQaAtP4gwjU+qqAzBa8Yws5B4d7U+SYsTqVFhT+q2VqtHPgktCK2jfTHFRUxAf/89Kb4DZiC/w4pXLoMqqqQCmv9pxbTVeAkcHry7qyCvHwRJ5pz2I1M37so1mpnSvzDklvTPm9H3Bq9Pkpe6EFObLxtwCT1rmo327Ss6sdbe3Udx36UNvvfAfpbJhTr4wP7WmjPf/i2OcfA5tIeI0xhSHe/gIyR8whDZFAjElOvVRF3MtT2PtmY1rk2az2ibq0Fut00lED5B2BgNrA6Sf0P3iriX/Q6mkU4hTY0syw69evBHB9ri2GH1A2r2h5YKKFN0CY1g/AtbktahWUOmfSx5NXsHtUQ11MHiojIXNQEs4PXYWBcwhzWAd4JbXNW+3ZwweubigShIHpHhbds55DEjVo/6UiXxu6X9L6YQziTf7lIx/AHaQ3gn6FQA3zNdzSdZjlohNEMwhgD6uMzBOh2vzxvu7KRdMux3LmaQ7+giTQRC43qLIwkX2RoQCFUF8vTI= X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?ofRYvUGW6Rfxhy6+I42HP3fnIGMeVJCJi3dbRlR1tGJnQx1dmxENahH6IaXL?= =?us-ascii?Q?WA3FrZWHsV6ovYStdlQtU2BR43WR3mbiUXcV+2zTfLk3gjJk5A4tU11Sk7/X?= =?us-ascii?Q?00u+reo/V+CWIw89CXoDyjEYkWeOJTn7ttJabOjAReTYAJdaBY9J5DkitieL?= =?us-ascii?Q?pDHYmnJrNKMhuIo40fEeyb5qC3YHhyP+k0ynPB6z5J+opkSHKEX9+SS4/xNv?= =?us-ascii?Q?ceDXWFAOQIX09O2b/u7cRRxGqHxkx9T6fW9tlKpDqyKmjUPgUuHRPCiB5Sy7?= =?us-ascii?Q?L7PBAJTs2POFsSaprEVaAJ3IlYkHNRZLscxBetA8/CqvlZZQ2kYQILrR5+bf?= =?us-ascii?Q?nVrh/IIW94owVqM7aQMV+GAmhBSrJlNX74ZYpWlh8ORyX6qBoeimroYKERTF?= =?us-ascii?Q?pNF4fV3Rv0bylRzXc31KjM62OEVoVGectf9jqjjAV1Mgp44QWYRSBGal6m5j?= =?us-ascii?Q?+4pU/qr26A56Pciiv8uR1Ey2RfegTSOz1z0hFv3YxH9JLFzRHkm1/Z9WvQ2+?= =?us-ascii?Q?aV0+zueMBnrJWYCA4U8pxpFMTSLh1Zn+6gSW9dGkq90apIdLxYxzxMxahdxR?= =?us-ascii?Q?l+37MPc39zs85aS+bdTw3GJXCD90djmO5QC4sVACShTZYH70uKrjMmQApJz+?= =?us-ascii?Q?jY X-OriginatorOrg: outlook.com X-MS-Exchange-CrossTenant-Network-Message-Id: 11d60fbb-aa77-457e-11a1-08db23391e7e X-MS-Exchange-CrossTenant-AuthSource: SJ0PR03MB5455.namprd03.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 12 Mar 2023 20:34:03.7087 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 84df9e7f-e9f6-40af-b435-aaaaaaaaaaaa X-MS-Exchange-CrossTenant-RMS-PersistedConsumerOrg: 00000000-0000-0000-0000-000000000000 X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM4PR03MB6061 Received-SPF: pass client-ip=2a01:111:f400:7e88::82e; envelope-from=outlook_98C99531806B1C22@outlook.com; helo=NAM10-DM6-obe.outbound.protection.outlook.com X-Spam_score_int: 7 X-Spam_score: 0.7 X-Spam_bar: / X-Spam_report: (0.7 / 5.0 requ) BAYES_00=-1.9, DKIM_ADSP_CUSTOM_MED=0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_EF=-0.1, FORGED_GMAIL_RCVD=1, FREEMAIL_ENVFROM_END_DIGIT=0.25, FREEMAIL_FORGED_FROMDOMAIN=0.25, FREEMAIL_FROM=0.001, HEADER_FROM_DIFFERENT_DOMAINS=0.25, NML_ADSP_CUSTOM_MED=0.9, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 autolearn=no autolearn_force=no X-Spam_action: no action X-Mailman-Approved-At: Sun, 12 Mar 2023 23:20:02 -0400 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:304384 Archived-At: 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? 2. How does it know what arguments to give Make? Package recipe file? 3. How does Elpa ensure it is picking up (say) the right Org for org->texi? MELPA.org has some documentation in its Github repo. Does ELPA have similar documentation? If so, where? > 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. -- David Masterson