Re: Bug-reference auto-setup for Rmail (please test)

[Tassilo Horn <tsdh@gnu.org>]

Eli Zaretskii <eliz@gnu.org> writes:

>> With the default value of `bug-reference-setup-from-mail-alist', the
>> user-visible effect would be that bug reference (bug#12345) would be
>> fontified and clickable and browse that bug report on debbugs.gnu.org
>> in terms of `browse-url'.
>
> OK, but what is this supposed to do for other forums, like
> emacs-devel? what is the relevant URL there?

The default value sets

  bug-reference-bug-regexp = "\\([Bb]ug ?#?\\)\\([0-9]+\\(?:#[0-9]+\\)?\\)"
  bug-reference-url-format = "https://debbugs.gnu.org/%s"

if some considered mail header (To, From, Cc, List-ID) matches something
emacs-related including emacs-devel@gnu.org (or some auctex, org-mode,
tramp) mailing list address or list-id.

For my job, I have

(add-to-list 'bug-reference-setup-from-mail-alist
             `("SHD" ;; all my work groups/maildirs have SHD in their name
               nil   ;; no header matching needed
               ,(concat "\\b\\(\\("
                        (regexp-opt '("ARCA" "BRI" "ECOJ" "KASE" "MOBA"
                                      "PORC" "LOWE"))
                        "-[0-9]\\{1,6\\}\\)\\)\\b")
               "http://srvjira-and.shd.lan:8080/browse/%s"))

which would highlight and clickify bug numbers like ECOJ-18292 and
browse them at our internal JIRA tracker.

>> Gnus and Mu4e create a fresh buffer with their viewing mode when
>> viewing another mail just like you'd get another buffer when finding
>> another file.
>
> Then yes, this should be set up when showing a message, not when
> turning on the Rmail mode.

Right, the question is just what is the best way to do it.  It has been
my design intention that

  1. there is no special setup needed (just enable `bug-reference-mode'
     where you like, and it'll work),

  2. it does never interfere with explicit user settings.  Therefore,
     the auto-setup runs in `bug-reference-mode's :after-hook, so if the
     2 variables are already set by file/dir-local variables or a hook
     function, it won't do anything.

So the alternative of having some special `bug-reference-rmail-setup'
function rmail users can add to `rmail-show-message-hook' would go
against 1 whereas the alternative of adding special handling in rmail
would possibly go against 2 because we couldn't know if bug-regexp &
url-format have been set by the previous auto-setup or if it has been an
explicit user setting, so resetting them to nil could be a violation of
that rule.

I don't know how Rmail users work but guess that some users have one
mbox file per mailinglist and use rmail-mode-hook to activate & setup
bug-reference explitly looking at the name of the mbox file.  In that
case, nuking the values and re-setting would be wrong.

So as it stands, I'd go with the special `bug-reference-rmail-setup'
function and document that in the Rmail info docs.

Bye,
Tassilo