GNU bug report logs - #37548
Implement sanitation of single-file package long description

Previous Next

Package: emacs;

Reported by: Bruno Félix Rezende Ribeiro <oitofelix <at> gnu.org>

Date: Sun, 29 Sep 2019 05:43:02 UTC

Severity: normal

Tags: patch

Fixed in version 28.1

Done: Stefan Kangas <stefan <at> marxist.se>

Bug is archived. No further changes may be made.

Full log


View this message in rfc822 format

From: Bruno Félix Rezende Ribeiro <oitofelix <at> gnu.org>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: Bruno Félix Rezende Ribeiro <oitofelix <at> gnu.org>, 37548 <at> debbugs.gnu.org
Subject: bug#37548: Implement sanitation of single-file package long description
Date: Tue, 08 Oct 2019 05:36:40 -0300
[Message part 1 (text/plain, inline)]
> Stefan Kangas <stefan <at> marxist.se> writes:
>
> I noticed something else:  There is actually already code duplication
> in package.el -- there is code to strip the commentary section in both
> package--get-description and describe-package-1.
>
> Perhaps it would make sense to look this all over and see how we can do better?

I decided to tackle the problem’s root.  After figuring out that every
function depending on ‘lm-commentary’ implemented their own ad-hoc
sanitation for the same effect, I changed ‘lm-commentary’ to return a
sanitized string and removed the code/functionality duplication from all
callers.


> I also have two general questions, which are applicable to both your
> recent patches:
>
> 1. It looks likely that this together with your other patch and your
> previous contributions will together amount to more than 15 lines of
> code.  That means that you would have to sign Copyright Assignment
> papers for GNU Emacs.  I see you're emailing from gnu.org, so I assume
> there are no surprises for you here; I guess Eli can help you sort
> that out if it's not already.

I’ve assigned my copyright for work on Emacs to the FSF already.


> 2. Could you please provide a commit message formatted as a changelog
> entry?  Details on this are in the CONTRIBUTE file in the repository.

Please, find it in the patch attached.


[0001-Globally-sanitize-single-file-package-long-descripti.patch (text/x-diff, attachment)]
[Message part 3 (text/plain, inline)]
-- 
Bruno Félix Rezende Ribeiro (oitofelix) [0x28D618AF]
<http://oitofelix.freeshell.org/>

This bug report was last modified 5 years and 114 days ago.

Previous Next


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