From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Noboru Ota Newsgroups: gmane.emacs.devel Subject: Re: [ELPA] Submitting new package Org-remark Date: Sat, 29 Jan 2022 10:30:44 +0100 Message-ID: <8635l6ga7v.fsf@nobiot.com> References: <865yq3el1f.fsf@nobiot.com> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="14855"; mail-complaints-to="usenet@ciao.gmane.io" Cc: emacs-devel@gnu.org To: Stefan Monnier Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sat Jan 29 10:35:05 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 1nDk8O-0003f3-Qk for ged-emacs-devel@m.gmane-mx.org; Sat, 29 Jan 2022 10:35:04 +0100 Original-Received: from localhost ([::1]:46978 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nDk8N-0002Jr-Se for ged-emacs-devel@m.gmane-mx.org; Sat, 29 Jan 2022 04:35:03 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:43578) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nDk4O-0008RB-9O for emacs-devel@gnu.org; Sat, 29 Jan 2022 04:32:20 -0500 Original-Received: from [2a01:4f8:fff0:2d:8::215] (port=50341 helo=outbound.soverin.net) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nDk4L-0008DN-Ul for emacs-devel@gnu.org; Sat, 29 Jan 2022 04:30:55 -0500 Original-Received: from smtp.soverin.net (unknown [10.10.3.28]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) (No client certificate requested) by outbound.soverin.net (Postfix) with ESMTPS id F2DE4601FB; Sat, 29 Jan 2022 09:30:47 +0000 (UTC) Original-Received: from smtp.soverin.net (smtp.soverin.net [159.69.232.142]) by soverin.net In-Reply-To: X-Host-Lookup-Failed: Reverse DNS lookup failed for 2a01:4f8:fff0:2d:8::215 (failed) Received-SPF: pass client-ip=2a01:4f8:fff0:2d:8::215; envelope-from=me@nobiot.com; helo=outbound.soverin.net X-Spam_score_int: -17 X-Spam_score: -1.8 X-Spam_bar: - X-Spam_report: (-1.8 / 5.0 requ) BAYES_00=-1.9, RCVD_IN_DNSWL_LOW=-0.7, RDNS_NONE=0.793, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=no 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:285545 Archived-At: Stefan Monnier writes: > Looks good, added, > [ I used `README.org` for the readme, instead of :make "README-elpa", tho ] Thank you, Stefan. Could we discuss the use of `README.org` and `README-elpa` a bit further, please? Perhaps we need both :readme and :make specs. I would like to use an ASCII export of README.org, not the raw README.org file for the package description. Currently, `describe-package' shows the raw `README.org` *after* the package has been installed. I have observed the following details below, and thought I should generate `README-elpa` to have the same `README` before and after installation of package. This way, I can also have a link to an Info node directly within the description (I provide an Info node as a user manual). Observation below in Emacs 27.2 on Windows and Emacs 29.0.50 on Ubuntu Linux: 1. Before the user installs a package, `describe-package` (and `package-list-packages`) displays `package-name-readme.txt`. ELPA generates it and when `README.org` is used as the README file, it gets exported to ASCII plain text (I believe this is done in functions `elpaa--get-README' and `elpaa--section-to-plain-text' in elpa-admin.el) 2. After the user has installed a package, `describe-package` (and `package-list-packages`) displays one of these files: "README-elpa" "README-elpa.md" "README" "README.rst" "README.org". When `README.org` is used, the raw text is displayed without being exported to ASCII format (I believe this is done in function `describe-package-1' and `package--get-description') Warm regards, Noboru