GNU bug report logs - #37546
26.3; Implement multi-file package README long description generation as described by elisp manual

Please note: This is a static page, with minimal formatting, updated once a day.
Click here to see this page with the latest information and nicer formatting.

Package: emacs; Reported by: oitofelix@HIDDEN (Bruno Félix Rezende Ribeiro); dated Sun, 29 Sep 2019 03:53:02 UTC; Maintainer for emacs is bug-gnu-emacs@HIDDEN.

Message received at submit <at> debbugs.gnu.org:


Received: (at submit) by debbugs.gnu.org; 29 Sep 2019 03:52:17 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Sat Sep 28 23:52:17 2019
Received: from localhost ([127.0.0.1]:51873 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1iEQFs-0000yM-L0
	for submit <at> debbugs.gnu.org; Sat, 28 Sep 2019 23:52:16 -0400
Received: from lists.gnu.org ([209.51.188.17]:36074)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <oitofelix@HIDDEN>) id 1iEQFq-0000yD-DM
 for submit <at> debbugs.gnu.org; Sat, 28 Sep 2019 23:52:14 -0400
Received: from eggs.gnu.org ([2001:470:142:3::10]:36544)
 by lists.gnu.org with esmtp (Exim 4.90_1)
 (envelope-from <oitofelix@HIDDEN>) id 1iEQFp-000887-18
 for bug-gnu-emacs@HIDDEN; Sat, 28 Sep 2019 23:52:14 -0400
X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org
X-Spam-Level: 
X-Spam-Status: No, score=-1.5 required=5.0 tests=ALL_TRUSTED,BAYES_05,
 URIBL_BLOCKED autolearn=disabled version=3.3.2
Received: from fencepost.gnu.org ([2001:470:142:3::e]:43671)
 by eggs.gnu.org with esmtp (Exim 4.71)
 (envelope-from <oitofelix@HIDDEN>) id 1iEQFo-00042R-RS
 for bug-gnu-emacs@HIDDEN; Sat, 28 Sep 2019 23:52:12 -0400
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 <oitofelix@HIDDEN>) id 1iEQFo-0005DT-Bj
 for bug-gnu-emacs@HIDDEN; Sat, 28 Sep 2019 23:52:12 -0400
From: oitofelix@HIDDEN (Bruno =?utf-8?Q?F=C3=A9lix?= Rezende Ribeiro)
To: bug-gnu-emacs@HIDDEN
Subject: 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@HIDDEN>
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="=-=-="
X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic]
X-Spam-Score: -2.3 (--)
X-Debbugs-Envelope-To: submit
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -3.3 (---)

--=-=-=
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@HIDDEN
 8   8  F     irc://chat.freenode.org/oitofelix
 88888  F     xmpp://oitofelix@HIDDEN


--=-=-=--




Acknowledgement sent to oitofelix@HIDDEN (Bruno Félix Rezende Ribeiro):
New bug report received and forwarded. Copy sent to bug-gnu-emacs@HIDDEN. Full text available.
Report forwarded to bug-gnu-emacs@HIDDEN:
bug#37546; Package emacs. Full text available.
Please note: This is a static page, with minimal formatting, updated once a day.
Click here to see this page with the latest information and nicer formatting.
Last modified: Sun, 29 Sep 2019 04:00:02 UTC

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997 nCipher Corporation Ltd, 1994-97 Ian Jackson.