From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Stefan Monnier Newsgroups: gmane.emacs.devel Subject: Re: Convert README.org to plain text README while installing package Date: Tue, 07 Jun 2022 13:55:04 -0400 Message-ID: References: <87leuca7v7.fsf@disroot.org> <87czfopmsd.fsf@gnu.org> <87h74ztshe.fsf@gmx.de> <871qw31ois.fsf@yahoo.com> <8735gj4ceo.fsf@gnu.org> <87sfojz63r.fsf@yahoo.com> <87h74z5nio.fsf@localhost> <87ilpf45mo.fsf@disroot.org> <87pmjnumzg.fsf@posteo.net> <877d5ut6z6.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="7878"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/29.0.50 (gnu/linux) Cc: Akib Azmain Turja , Ihor Radchenko , Po Lu , Tassilo Horn , Michael Albinus , Alan Mackenzie , Stefan Kangas , emacs-devel@gnu.org To: Philip Kaludercic Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Tue Jun 07 19:57:57 2022 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 1nydSn-0001nG-Is for ged-emacs-devel@m.gmane-mx.org; Tue, 07 Jun 2022 19:57:57 +0200 Original-Received: from localhost ([::1]:37738 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nydSm-0003Xh-Cw for ged-emacs-devel@m.gmane-mx.org; Tue, 07 Jun 2022 13:57:56 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:48982) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nydQI-00028O-EP for emacs-devel@gnu.org; Tue, 07 Jun 2022 13:55:25 -0400 Original-Received: from mailscanner.iro.umontreal.ca ([132.204.25.50]:64651) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nydQ6-0005bi-8S; Tue, 07 Jun 2022 13:55:20 -0400 Original-Received: from pmg2.iro.umontreal.ca (localhost.localdomain [127.0.0.1]) by pmg2.iro.umontreal.ca (Proxmox) with ESMTP id 5C5E581146; Tue, 7 Jun 2022 13:55:08 -0400 (EDT) Original-Received: from mail01.iro.umontreal.ca (unknown [172.31.2.1]) by pmg2.iro.umontreal.ca (Proxmox) with ESMTP id 9A18680722; Tue, 7 Jun 2022 13:55:06 -0400 (EDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=iro.umontreal.ca; s=mail; t=1654624506; bh=G9OMU4x7hmFlJA7u5d2M/IGXDwCTr996SZJfykHP6l4=; h=From:To:Cc:Subject:References:Date:In-Reply-To:From; b=nYU9mYokgHP45us6t1TQhAvwLU+bMqicdYtP9sJsJbQLMGuJjomH/BQKds0oGfRTr 5iZKXg5rA8VZSlI+dexursaTbf5nvh0RFrmG1i2RIMhDFTs+hM1ACafP9zixVfKVXY OVHjMQW0l2Yop6jRmZeV7VD9vU3c/KlMHo8v8a/laGJ+vevyHwJ3OwTiZZzWoFxsMU /X5TbH8dnRMX183wLFdGFLMzA5KPoNbfYOXmug/rgtgE0ifPDcwT6w5dngkXIYiOnN 1ijG0soQwGbkFSz+FfFIsxd8QWHh/u/2r3xqcNBUDiP+esRA8p+keyOOWJJKSB42/I kC8FB/GvTyhjA== Original-Received: from alfajor (unknown [45.44.229.252]) by mail01.iro.umontreal.ca (Postfix) with ESMTPSA id 271E1120341; Tue, 7 Jun 2022 13:55:06 -0400 (EDT) In-Reply-To: <877d5ut6z6.fsf@posteo.net> (Philip Kaludercic's message of "Mon, 06 Jun 2022 10:35:25 +0000") Received-SPF: pass client-ip=132.204.25.50; envelope-from=monnier@iro.umontreal.ca; helo=mailscanner.iro.umontreal.ca X-Spam_score_int: -19 X-Spam_score: -2.0 X-Spam_bar: -- X-Spam_report: (-2.0 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 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" Xref: news.gmane.io gmane.emacs.devel:290870 Archived-At: > From 9d973044a346860d3fc6164fe75ad8cd9721a595 Mon Sep 17 00:00:00 2001 > From: Philip Kaludercic > Date: Mon, 6 Jun 2022 12:34:40 +0200 > Subject: [PATCH] Render Org documentation in a plain-text README-elpa file > > * elpa-admin.el (elpaa--make-one-tarball-1): Call elpaa--write-plain-readme. > (elpaa--write-plain-readme): Add new function. That looks OK, feel free to push that to `elpa-admin`. Comments: - you'd get more bonus points by arranging for the code to (re)use the existing plain text (which is currently produced later when (re)generating the HTML page, so it would take a fair bit of code reorg to get that. In the mean time, a FIXME comment seems in order). - Your code may end up "rendering" a Markdown file for no obvious benefit since the rendering is a no-op (tho I think this is very hypothetical and likely can't happen because of other constraints). - We might also add a `README-elpa` file when the readme file has a name not recognized by `package--get-description`. Stefan