From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: oitofelix@gnu.org (Bruno =?UTF-8?Q?F=C3=A9lix?= Rezende Ribeiro) Newsgroups: gmane.emacs.bugs Subject: bug#37546: 26.3; Implement multi-file package README long description generation as described by elisp manual Date: Sun, 29 Sep 2019 00:52:04 -0300 Message-ID: <87d0fjbvyz.fsf@oitofelix.com> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="126011"; mail-complaints-to="usenet@blaine.gmane.org" To: 37546@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sun Sep 29 05:53:14 2019 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([209.51.188.17]) by blaine.gmane.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1iEQGm-000WZ1-O2 for geb-bug-gnu-emacs@m.gmane.org; Sun, 29 Sep 2019 05:53:12 +0200 Original-Received: from localhost ([::1]:36586 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iEQGk-0008CF-Jy for geb-bug-gnu-emacs@m.gmane.org; Sat, 28 Sep 2019 23:53:10 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:36590) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iEQGd-0008Bs-HM for bug-gnu-emacs@gnu.org; Sat, 28 Sep 2019 23:53:04 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iEQGc-0004L2-EW for bug-gnu-emacs@gnu.org; Sat, 28 Sep 2019 23:53:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:43052) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1iEQGc-0004Kv-BI for bug-gnu-emacs@gnu.org; Sat, 28 Sep 2019 23:53:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1iEQGc-0000zN-8m for bug-gnu-emacs@gnu.org; Sat, 28 Sep 2019 23:53:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: oitofelix@gnu.org (Bruno =?UTF-8?Q?F=C3=A9lix?= Rezende Ribeiro) Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 29 Sep 2019 03:53:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 37546 X-GNU-PR-Package: emacs X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.15697291373747 (code B ref -1); Sun, 29 Sep 2019 03:53:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 29 Sep 2019 03:52:17 +0000 Original-Received: from localhost ([127.0.0.1]:51873 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iEQFs-0000yM-L0 for submit@debbugs.gnu.org; Sat, 28 Sep 2019 23:52:16 -0400 Original-Received: from lists.gnu.org ([209.51.188.17]:36074) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iEQFq-0000yD-DM for submit@debbugs.gnu.org; Sat, 28 Sep 2019 23:52:14 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:36544) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iEQFp-000887-18 for bug-gnu-emacs@gnu.org; Sat, 28 Sep 2019 23:52:14 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:43671) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1iEQFo-00042R-RS for bug-gnu-emacs@gnu.org; Sat, 28 Sep 2019 23:52:12 -0400 Original-Received: from [189.15.124.78] (port=48970 helo=felix-laptop) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_128_CBC_SHA1:128) (Exim 4.82) (envelope-from ) id 1iEQFo-0005DT-Bj for bug-gnu-emacs@gnu.org; Sat, 28 Sep 2019 23:52:12 -0400 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 209.51.188.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:167583 Archived-At: --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Hello Emacs developers, The inlined patch implements the (already expected) generation of multi-file package long description from a potential README file residing inside the package=E2=80=99s content directory. Currently Emacs o= nly implements the long description generation from commentary sections and for single-file packages. This behavior is documented in =E2=80=98(elisp) Multi-file Packages=E2=80= =99 and the function =E2=80=98package-upload-buffer-internal=E2=80=99 from =E2=80=98pac= kage-x.el=E2=80=99 had a =E2=80=98FIXME: Get it from the README file.=E2=80=99 right on the spot of = this implementation. Let me know if any change is necessary. Thanks! --=-=-= Content-Type: text/x-diff Content-Disposition: inline; filename=package-x-multi-file-README-long-description.patch diff --git a/lisp/emacs-lisp/package-x.el b/lisp/emacs-lisp/package-x.el index 2815be3..d929cf5 100644 --- a/lisp/emacs-lisp/package-x.el +++ b/lisp/emacs-lisp/package-x.el @@ -205,7 +205,10 @@ if it exists." (commentary (pcase file-type ('single (lm-commentary)) - ('tar nil))) ;; FIXME: Get it from the README file. + ('tar (when (file-exists-p "README") + (with-temp-buffer + (insert-file-contents "README") + (buffer-string)))))) (extras (package-desc-extras pkg-desc)) (pkg-version (package-version-join split-version)) (pkg-buffer (current-buffer))) --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable --=20 88888 FFFFF Bruno F=C3=A9lix Rezende Ribeiro (oitofelix) [0x28D618AF] 8 8 F http://oitofelix.freeshell.org/ 88888 FFFF mailto:oitofelix@gnu.org 8 8 F irc://chat.freenode.org/oitofelix 88888 F xmpp://oitofelix@riseup.net --=-=-=--