bug#57877: [PATCH] Add empty X-Debbugs-Cc header to bug report template

bug#57877: [PATCH] Add empty X-Debbugs-Cc header to bug report template

[Augusto Stoffel]

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

Tags: patch

I can never remember what that funny CC header was when I need it, how
about adding an empty X-Debbugs-Cc to the bug report and patch message
templates?

An alternative would be to add a reminder and explanation about it to
that portion of text that gets deleted (“This bug report will be
sent...”).

In GNU Emacs 29.0.50 (build 1, x86_64-pc-linux-gnu, GTK+ Version
 3.24.34, cairo version 1.17.6) of 2022-09-14 built on ars3
Repository revision: a9941269683fe50673d0aa81feefb7a9d3d8a6b9
Repository branch: HEAD
System Description: Fedora Linux 36 (Workstation Edition)

Configured using:
 'configure --with-pgtk'


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Add-empty-X-Debbugs-Cc-header-to-bug-report-template.patch --]
[-- Type: text/patch, Size: 1421 bytes --]

From 8a15db7a0ad9e102ed7bb50bb8a9e02e232cce96 Mon Sep 17 00:00:00 2001
From: Augusto Stoffel <arstoffel@gmail.com>
Date: Sat, 17 Sep 2022 10:39:46 +0200
Subject: [PATCH] Add empty X-Debbugs-Cc header to bug report template

* lisp/mail/emacsbug.el: (report-emacs-bug, submit-emacs-patch): Add
empty X-Debbugs-Cc header.
---
 lisp/mail/emacsbug.el | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

diff --git a/lisp/mail/emacsbug.el b/lisp/mail/emacsbug.el
index a85ceaf1a5..ea99e3eddc 100644
--- a/lisp/mail/emacsbug.el
+++ b/lisp/mail/emacsbug.el
@@ -228,7 +228,7 @@ report-emacs-bug
           (set-window-dedicated-p nil nil)
           (set-frame-parameter nil 'unsplittable nil))
       (error nil))
-    (compose-mail report-emacs-bug-address topic)
+    (compose-mail report-emacs-bug-address topic '(("X-Debbugs-Cc" . "")))
     ;; The rest of this does not execute if the user was asked to
     ;; confirm and said no.
     (when (eq major-mode 'message-mode)
@@ -518,7 +518,10 @@ submit-emacs-patch
     (goto-char (point-min))
     (view-mode 1)
     (button-mode 1))
-  (compose-mail-other-window report-emacs-bug-address subject)
+  (compose-mail-other-window report-emacs-bug-address
+                             subject
+                             '(("X-Debbugs-Cc" . "")))
+  (message-sort-headers)
   (message-goto-body)
   (insert "\n\n\n")
   (emacs-bug--system-description)
-- 
2.37.3

bug#57877: [PATCH] Add empty X-Debbugs-Cc header to bug report template

[Daniel Martín via Bug reports for GNU Emacs, the Swiss army knife of text editors]

Augusto Stoffel <arstoffel@gmail.com> writes:

> Tags: patch
>
> I can never remember what that funny CC header was when I need it, how
> about adding an empty X-Debbugs-Cc to the bug report and patch message
> templates?
>
> An alternative would be to add a reminder and explanation about it to
> that portion of text that gets deleted (“This bug report will be
> sent...”).
>

I think this change may confuse some users because there will be a blank
X-Debbugs-Cc header when reporting a bug (they'll ask themselves "what
should I put here?, what does this do?").  I think we should update the
bug template to explain when to fill that special mail header, at least.

But, if the problem is not general enough, we may simply expose a custom
variable so that users can provide custom headers in bug reports.  With
that approach, sending bug reports to Emacs by default remains as simple
as before, while experienced bug reporters can still provide the mail
header in their customizations, if they want to.

Opinions?

bug#57877: [PATCH] Add empty X-Debbugs-Cc header to bug report template

[Augusto Stoffel]

On Sat, 17 Sep 2022 at 11:31, Daniel Martín wrote:

> Augusto Stoffel <arstoffel@gmail.com> writes:
>
>> Tags: patch
>>
>> I can never remember what that funny CC header was when I need it, how
>> about adding an empty X-Debbugs-Cc to the bug report and patch message
>> templates?
>>
>> An alternative would be to add a reminder and explanation about it to
>> that portion of text that gets deleted (“This bug report will be
>> sent...”).
>>
>
> I think this change may confuse some users because there will be a blank
> X-Debbugs-Cc header when reporting a bug (they'll ask themselves "what
> should I put here?, what does this do?").  I think we should update the
> bug template to explain when to fill that special mail header, at least.
>
> But, if the problem is not general enough, we may simply expose a custom
> variable so that users can provide custom headers in bug reports.  With
> that approach, sending bug reports to Emacs by default remains as simple
> as before, while experienced bug reporters can still provide the mail
> header in their customizations, if they want to.
>
> Opinions?

That makes sense.  From my perspective either (or both) alternatives you
propose are good.

bug#57877: [PATCH] Add empty X-Debbugs-Cc header to bug report template

[Stefan Kangas]

Daniel Martín via "Bug reports for GNU Emacs, the Swiss army knife of
text editors" <bug-gnu-emacs@gnu.org> writes:

> I think this change may confuse some users because there will be a blank
> X-Debbugs-Cc header when reporting a bug (they'll ask themselves "what
> should I put here?, what does this do?").  I think we should update the
> bug template to explain when to fill that special mail header, at least.

I think we should just make `message-goto-cc' command use
"X-Debbugs-CC" in both `report-emacs-bug' and `submit-emacs-patch'.

For extra points, make it do the same if "bug-gnu-emacs@gnu.org" (and
some other well-known debbugs lists, customizable) is already in the
"To:" header.

bug#57877: [PATCH] Add empty X-Debbugs-Cc header to bug report template

[Michael Albinus]

Stefan Kangas <stefankangas@gmail.com> writes:

Hi,

> For extra points, make it do the same if "bug-gnu-emacs@gnu.org" (and
> some other well-known debbugs lists, customizable) is already in the
> "To:" header.

<https://debbugs.gnu.org/Packages.html> lists the currently hosted
projects on debbugs.gnu.org. The "Bug mailing list" column contains a
link to the project specific bug mailing lists, email addresses for bug
submissions could be extracted from there.

Yes, it would be some work to earn the bonus points :-)

Best regards, Michael.

bug#57877: [PATCH] Add empty X-Debbugs-Cc header to bug report template

[Stefan Kangas]

Michael Albinus <michael.albinus@gmx.de> writes:

> <https://debbugs.gnu.org/Packages.html> lists the currently hosted
> projects on debbugs.gnu.org.

And then the Debian bug tracker itself, of course.

bug#57877: [PATCH] Add empty X-Debbugs-Cc header to bug report template

[Lars Ingebrigtsen]

Stefan Kangas <stefankangas@gmail.com> writes:

> I think we should just make `message-goto-cc' command use
> "X-Debbugs-CC" in both `report-emacs-bug' and `submit-emacs-patch'.

Or just add new commands to insert debbugs headers when reporting a
bug -- I think that's simpler.

bug#57877: [PATCH] Add empty X-Debbugs-Cc header to bug report template

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

Stefan Kangas <stefankangas@gmail.com> writes:

> Daniel Martín via "Bug reports for GNU Emacs, the Swiss army knife of
> text editors" <bug-gnu-emacs@gnu.org> writes:
>
>> I think this change may confuse some users because there will be a blank
>> X-Debbugs-Cc header when reporting a bug (they'll ask themselves "what
>> should I put here?, what does this do?").  I think we should update the
>> bug template to explain when to fill that special mail header, at least.
>
> I think we should just make `message-goto-cc' command use
> "X-Debbugs-CC" in both `report-emacs-bug' and `submit-emacs-patch'.

Apparently, the requested header is added in `report-emacs-bug' by commit
040cba5d3332. Shouldn't we do the same for `submit-emacs-patch', and
close the bug?

Best regards, Michael.

bug#57877: [PATCH] Add empty X-Debbugs-Cc header to bug report template

[Stefan Kangas]

Michael Albinus <michael.albinus@gmx.de> writes:

> Stefan Kangas <stefankangas@gmail.com> writes:
>
>> Daniel Martín via "Bug reports for GNU Emacs, the Swiss army knife of
>> text editors" <bug-gnu-emacs@gnu.org> writes:
>>
>>> I think this change may confuse some users because there will be a blank
>>> X-Debbugs-Cc header when reporting a bug (they'll ask themselves "what
>>> should I put here?, what does this do?").  I think we should update the
>>> bug template to explain when to fill that special mail header, at least.
>>
>> I think we should just make `message-goto-cc' command use
>> "X-Debbugs-CC" in both `report-emacs-bug' and `submit-emacs-patch'.
>
> Apparently, the requested header is added in `report-emacs-bug' by commit
> 040cba5d3332. Shouldn't we do the same for `submit-emacs-patch', and
> close the bug?

Makes sense to me.

bug#57877: [PATCH] Add empty X-Debbugs-Cc header to bug report template

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

Version: 31.1

Stefan Kangas <stefankangas@gmail.com> writes:

> Michael Albinus <michael.albinus@gmx.de> writes:
>
>> Stefan Kangas <stefankangas@gmail.com> writes:
>>
>>> Daniel Martín via "Bug reports for GNU Emacs, the Swiss army knife of
>>> text editors" <bug-gnu-emacs@gnu.org> writes:
>>>
>>>> I think this change may confuse some users because there will be a blank
>>>> X-Debbugs-Cc header when reporting a bug (they'll ask themselves "what
>>>> should I put here?, what does this do?").  I think we should update the
>>>> bug template to explain when to fill that special mail header, at least.
>>>
>>> I think we should just make `message-goto-cc' command use
>>> "X-Debbugs-CC" in both `report-emacs-bug' and `submit-emacs-patch'.
>>
>> Apparently, the requested header is added in `report-emacs-bug' by commit
>> 040cba5d3332. Shouldn't we do the same for `submit-emacs-patch', and
>> close the bug?
>
> Makes sense to me.

Done, pushed to master. Closing the bug.

Best regards, Michael.