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: [ELPA] Submitting new package Org-remark Date: Sat, 29 Jan 2022 17:26:02 -0500 Message-ID: References: <865yq3el1f.fsf@nobiot.com> <8635l6ga7v.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="5749"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/29.0.50 (gnu/linux) Cc: emacs-devel@gnu.org To: Noboru Ota Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sat Jan 29 23:28:28 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 1nDwCp-0001HN-MC for ged-emacs-devel@m.gmane-mx.org; Sat, 29 Jan 2022 23:28:27 +0100 Original-Received: from localhost ([::1]:55404 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nDwCo-00029j-1q for ged-emacs-devel@m.gmane-mx.org; Sat, 29 Jan 2022 17:28:26 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:58326) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nDwAj-0000mK-SO for emacs-devel@gnu.org; Sat, 29 Jan 2022 17:26:17 -0500 Original-Received: from mailscanner.iro.umontreal.ca ([132.204.25.50]:53240) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nDwAg-0005jn-In for emacs-devel@gnu.org; Sat, 29 Jan 2022 17:26:16 -0500 Original-Received: from pmg3.iro.umontreal.ca (localhost [127.0.0.1]) by pmg3.iro.umontreal.ca (Proxmox) with ESMTP id 98B7F442AAD; Sat, 29 Jan 2022 17:26:12 -0500 (EST) Original-Received: from mail01.iro.umontreal.ca (unknown [172.31.2.1]) by pmg3.iro.umontreal.ca (Proxmox) with ESMTP id C5D42442AA9; Sat, 29 Jan 2022 17:26:10 -0500 (EST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=iro.umontreal.ca; s=mail; t=1643495170; bh=AqWZnY+sjAGCfQ3blS0JpgPYsNJv6UgcbjrpYWlz/G8=; h=From:To:Cc:Subject:In-Reply-To:References:Date:From; b=TAnrgHjFrOhJWSoGc/feUOyfd5dptkPYsG/WAzwKjypNI4RWMWImnL5BCB6ND1+od 0QejJy1Gv8cx19pKvXOClPFKAF8LwFMINPtZuXzCh9F/A919HtLnTdcsFFtyM9TMaK 0WxCRtI7/dmKVm3z6BA84NTzAzDvmZXQbVg4zHEiY5gNSfJsbCSn2rzROmsSnmR6QV bPwcybqQHwc7oWclowm1M6UQf6W3XcpICd1YiRVOuWrrVk+Beraacyp7mFnMLLF/Nm 8HjR+secQ2PPb/6WW6LTksBg9PMgsW0xiBQctPQ5k2CP8B4de2LjXTdA5lQFHJy6cb W47JuRgW+iVRQ== Original-Received: from ceviche (76-10-138-212.dsl.teksavvy.com [76.10.138.212]) by mail01.iro.umontreal.ca (Postfix) with ESMTPSA id 69A3E120782; Sat, 29 Jan 2022 17:26:10 -0500 (EST) In-Reply-To: <8635l6ga7v.fsf@nobiot.com> (Noboru Ota's message of "Sat, 29 Jan 2022 10:30:44 +0100") Received-SPF: pass client-ip=132.204.25.50; envelope-from=monnier@iro.umontreal.ca; helo=mailscanner.iro.umontreal.ca X-Spam_score_int: -42 X-Spam_score: -4.3 X-Spam_bar: ---- X-Spam_report: (-4.3 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, RCVD_IN_DNSWL_MED=-2.3, 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:285574 Archived-At: [ BTW, your package didn't build yet because of: ======== Building tarball archive-devel/org-remark-0.2.0.0.20220129.95541.tar... Problem with copyright notices: Missing copyright notice in org-remark/demo/custom-pens.el Build error for archive-devel/org-remark-0.2.0.0.20220129.95541.tar: (error "Abort") ######## Build of package archive-devel/org-remark-0.2.0.0.20220129.95541.tar FAILED!! ] > I would like to use an ASCII export of README.org, not the raw > README.org file for the package description. The current scripts generate an HTML version of `README.org` for the webpage and an ASCII version for the `-readme.txt` (used by `list-packages`) from the :readme, so I think it should be better overall, and it definitely should not use the raw Org text any more. > Currently, `describe-package' shows the raw `README.org` *after* the > package has been installed. This should depend on when the package was built: the scripts were changed a month or two ago and they only affect those packages that have been rebuilt since. > 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) That's right. > 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') Oh, my! You're absolutely right. I wasn't aware of this code in `describe-packages`. We should improve it to use the same approach as in `elpaa--get-README` and `elpaa--section-to-plain-text` (tho maybe using some other part of Org which renders directly in an Emacs buffer rather than a txt file, so it looks better). There's also the problem that `describe-package` doesn't have access to the spec we put in `elpa-packages`, so it can only guess which README file to use based on a heuristic. Any chance you'd be interested in improving `describe-package`? Stefan