bug#69712: Package author/maintainer printing fix

bug#69712: Package author/maintainer printing fix

[Juri Linkov]

[-- Attachment #1: Type: text/plain, Size: 723 bytes --]

There are many packages with non-dot author/maintainer format that fail with

Debugger entered--Lisp error: (wrong-type-argument listp "XXIV")
  car("XXIV")
  package--print-email-button("XXIV")
  describe-package-1(#s(package-desc :name chaos-mode ((:authors ("XXIV")) (:maintainers ("XXIV")) (:maintainer "XXIV"))))
  describe-package(#s(package-desc :name chaos-mode ((:authors ("XXIV")) (:maintainers ("XXIV")) (:maintainer "XXIV"))))
  package-menu-describe-package(#<marker (moves after insertion) at 67389 in *Packages*>)
  button-activate(#<marker (moves after insertion) at 67389 in *Packages*> nil)
  push-button(67389)
  funcall-interactively(push-button 67389)
  command-execute(push-button)

Here is the fix:


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: package--print-email-button.patch --]
[-- Type: text/x-diff, Size: 1469 bytes --]

diff --git a/lisp/emacs-lisp/package.el b/lisp/emacs-lisp/package.el
index fe7b10f569a..790860df2a7 100644
--- a/lisp/emacs-lisp/package.el
+++ b/lisp/emacs-lisp/package.el
@@ -3082,19 +3082,21 @@ package--print-email-button
   "Insert a button whose action will send an email to RECIPIENT.
 NAME should have the form (FULLNAME . EMAIL) where FULLNAME is
 either a full name or nil, and EMAIL is a valid email address."
-  (when (car recipient)
-    (insert (car recipient)))
-  (when (and (car recipient) (cdr recipient))
-    (insert " "))
-  (when (cdr recipient)
-    (insert "<")
-    (insert-text-button (cdr recipient)
-                        'follow-link t
-                        'action (lambda (_)
-                                  (compose-mail
-                                   (format "%s <%s>" (car recipient) (cdr recipient)))))
-    (insert ">"))
-  (insert "\n"))
+  (if (stringp recipient)
+      (insert recipient "\n")
+    (when (car recipient)
+      (insert (car recipient)))
+    (when (and (car recipient) (cdr recipient))
+      (insert " "))
+    (when (cdr recipient)
+      (insert "<")
+      (insert-text-button (cdr recipient)
+                          'follow-link t
+                          'action (lambda (_)
+                                    (compose-mail
+                                     (format "%s <%s>" (car recipient) (cdr recipient)))))
+      (insert ">"))
+    (insert "\n")))
 
 \f
 ;;;; Package menu mode.

bug#69712: Package author/maintainer printing fix

[J.P.]

Hi Juri,

Don't mind me. Just wanted to note a somewhat related bug:

  https://debbugs.gnu.org/cgi/bugreport.cgi?bug=68660

Thanks,
J.P.

bug#69712: Package author/maintainer printing fix

[Philip Kaludercic]

Juri Linkov <juri@linkov.net> writes:

> There are many packages with non-dot author/maintainer format that fail with
>
> Debugger entered--Lisp error: (wrong-type-argument listp "XXIV")
>   car("XXIV")
>   package--print-email-button("XXIV")
>   describe-package-1(#s(package-desc :name chaos-mode ((:authors ("XXIV")) (:maintainers ("XXIV")) (:maintainer "XXIV"))))
>   describe-package(#s(package-desc :name chaos-mode ((:authors ("XXIV")) (:maintainers ("XXIV")) (:maintainer "XXIV"))))
>   package-menu-describe-package(#<marker (moves after insertion) at 67389 in *Packages*>)
>   button-activate(#<marker (moves after insertion) at 67389 in *Packages*> nil)
>   push-button(67389)
>   funcall-interactively(push-button 67389)
>   command-execute(push-button)
>
> Here is the fix:

Is there any reason not to apply this?  It makes sense to me.

> diff --git a/lisp/emacs-lisp/package.el b/lisp/emacs-lisp/package.el
> index fe7b10f569a..790860df2a7 100644
> --- a/lisp/emacs-lisp/package.el
> +++ b/lisp/emacs-lisp/package.el
> @@ -3082,19 +3082,21 @@ package--print-email-button
>    "Insert a button whose action will send an email to RECIPIENT.
>  NAME should have the form (FULLNAME . EMAIL) where FULLNAME is
>  either a full name or nil, and EMAIL is a valid email address."
> -  (when (car recipient)
> -    (insert (car recipient)))
> -  (when (and (car recipient) (cdr recipient))
> -    (insert " "))
> -  (when (cdr recipient)
> -    (insert "<")
> -    (insert-text-button (cdr recipient)
> -                        'follow-link t
> -                        'action (lambda (_)
> -                                  (compose-mail
> -                                   (format "%s <%s>" (car recipient) (cdr recipient)))))
> -    (insert ">"))
> -  (insert "\n"))
> +  (if (stringp recipient)
> +      (insert recipient "\n")
> +    (when (car recipient)
> +      (insert (car recipient)))
> +    (when (and (car recipient) (cdr recipient))
> +      (insert " "))
> +    (when (cdr recipient)
> +      (insert "<")
> +      (insert-text-button (cdr recipient)
> +                          'follow-link t
> +                          'action (lambda (_)
> +                                    (compose-mail
> +                                     (format "%s <%s>" (car recipient) (cdr recipient)))))
> +      (insert ">"))
> +    (insert "\n")))
>  
>  \f
>  ;;;; Package menu mode.
>

-- 
	Philip Kaludercic on peregrine

bug#69712: Package author/maintainer printing fix

[Eli Zaretskii]

> Cc: 69712@debbugs.gnu.org
> From: Philip Kaludercic <philipk@posteo.net>
> Date: Fri, 22 Mar 2024 08:47:38 +0000
> 
> Juri Linkov <juri@linkov.net> writes:
> 
> > There are many packages with non-dot author/maintainer format that fail with
> >
> > Debugger entered--Lisp error: (wrong-type-argument listp "XXIV")
> >   car("XXIV")
> >   package--print-email-button("XXIV")
> >   describe-package-1(#s(package-desc :name chaos-mode ((:authors ("XXIV")) (:maintainers ("XXIV")) (:maintainer "XXIV"))))
> >   describe-package(#s(package-desc :name chaos-mode ((:authors ("XXIV")) (:maintainers ("XXIV")) (:maintainer "XXIV"))))
> >   package-menu-describe-package(#<marker (moves after insertion) at 67389 in *Packages*>)
> >   button-activate(#<marker (moves after insertion) at 67389 in *Packages*> nil)
> >   push-button(67389)
> >   funcall-interactively(push-button 67389)
> >   command-execute(push-button)
> >
> > Here is the fix:
> 
> Is there any reason not to apply this?  It makes sense to me.

Stefan, any comments on the proposal below?

> > diff --git a/lisp/emacs-lisp/package.el b/lisp/emacs-lisp/package.el
> > index fe7b10f569a..790860df2a7 100644
> > --- a/lisp/emacs-lisp/package.el
> > +++ b/lisp/emacs-lisp/package.el
> > @@ -3082,19 +3082,21 @@ package--print-email-button
> >    "Insert a button whose action will send an email to RECIPIENT.
> >  NAME should have the form (FULLNAME . EMAIL) where FULLNAME is
> >  either a full name or nil, and EMAIL is a valid email address."
> > -  (when (car recipient)
> > -    (insert (car recipient)))
> > -  (when (and (car recipient) (cdr recipient))
> > -    (insert " "))
> > -  (when (cdr recipient)
> > -    (insert "<")
> > -    (insert-text-button (cdr recipient)
> > -                        'follow-link t
> > -                        'action (lambda (_)
> > -                                  (compose-mail
> > -                                   (format "%s <%s>" (car recipient) (cdr recipient)))))
> > -    (insert ">"))
> > -  (insert "\n"))
> > +  (if (stringp recipient)
> > +      (insert recipient "\n")
> > +    (when (car recipient)
> > +      (insert (car recipient)))
> > +    (when (and (car recipient) (cdr recipient))
> > +      (insert " "))
> > +    (when (cdr recipient)
> > +      (insert "<")
> > +      (insert-text-button (cdr recipient)
> > +                          'follow-link t
> > +                          'action (lambda (_)
> > +                                    (compose-mail
> > +                                     (format "%s <%s>" (car recipient) (cdr recipient)))))
> > +      (insert ">"))
> > +    (insert "\n")))
> >  
> >  \f
> >  ;;;; Package menu mode.
> >
> 
> -- 
> 	Philip Kaludercic on peregrine
> 
> 
> 
> 

bug#69712: Package author/maintainer printing fix

[Juri Linkov]

>> Here is the fix:
>
> Is there any reason not to apply this?  It makes sense to me.

I waited until the related bug#68660 will be fixed, as J.P. noted.
But maybe fixing doesn't depend on bug#68660?

bug#69712: Package author/maintainer printing fix

[Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors]

> There are many packages with non-dot author/maintainer format that fail with

Could you give some examples?


        Stefan

bug#69712: Package author/maintainer printing fix

[Juri Linkov]

>> There are many packages with non-dot author/maintainer format that fail with
>
> Could you give some examples?

An example is chaos-mode on MELPA.  There are many more.
For example, few of them near chaos-mode:
challenger-deep-theme, chatgpt-shell, etc.

bug#69712: Package author/maintainer printing fix

[Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors]

> Here is the fix:

I suggest the following fix instead.
Can you confirm that it fixes the problem for you as well?


        Stefan


diff --git a/lisp/emacs-lisp/package.el b/lisp/emacs-lisp/package.el
index fe7b10f569a..ab1731aeb54 100644
--- a/lisp/emacs-lisp/package.el
+++ b/lisp/emacs-lisp/package.el
@@ -2941,7 +2941,7 @@ describe-package-1
         (insert " "))
       (insert "\n"))
     (when maintainers
-      (unless (proper-list-p maintainers)
+      (when (stringp (car maintainers))
         (setq maintainers (list maintainers)))
       (package--print-help-section
           (if (cdr maintainers) "Maintainers" "Maintainer"))

bug#69712: Package author/maintainer printing fix

[Juri Linkov]

> I suggest the following fix instead.
> Can you confirm that it fixes the problem for you as well?
>
> diff --git a/lisp/emacs-lisp/package.el b/lisp/emacs-lisp/package.el
> @@ -2941,7 +2941,7 @@ describe-package-1
>          (insert " "))
>        (insert "\n"))
>      (when maintainers
> -      (unless (proper-list-p maintainers)
> +      (when (stringp (car maintainers))
>          (setq maintainers (list maintainers)))

I confirm this completely fixes the problem.

bug#69712: Package author/maintainer printing fix

[Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors]

>> I suggest the following fix instead.
>> Can you confirm that it fixes the problem for you as well?
>>
>> diff --git a/lisp/emacs-lisp/package.el b/lisp/emacs-lisp/package.el
>> @@ -2941,7 +2941,7 @@ describe-package-1
>>          (insert " "))
>>        (insert "\n"))
>>      (when maintainers
>> -      (unless (proper-list-p maintainers)
>> +      (when (stringp (car maintainers))
>>          (setq maintainers (list maintainers)))
>
> I confirm this completely fixes the problem.

Thanks, pushed to `master`.


        Stefan

bug#69712: Package author/maintainer printing fix

[Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors]

>   (:maintainers (nil . "Drew Adams (concat \"drew.adams\" \"@\" \"oracle\" \".com\")"))

Hmm... I pushed a further fix which should hopefully fix this without
re-introducing another problem.


        Stefan