Status of TODO remove obsolete bug-reporting commando

Status of TODO remove obsolete bug-reporting commando

[Stefan Kangas]

[-- Attachment #1.1: Type: text/plain, Size: 1570 bytes --]

I've been looking into the following TODO:

> ** Check for any included packages that define obsolete bug-reporting
commands.
> Change them to use report-emacs-bug.
> *** Related functions:
> **** gnus-bug
> **** report-calc-bug
> **** org-submit-bug-report
> **** lm-report-bug
> **** tramp-bug
> **** c-submit-bug-report
> [Do all of them need changing?]

The final question leaves the prospective contributor in some doubt. I
think the first step is to clarify what it is that should be done.

First: Do all of them need changing?  If yes, should we remove that
question in etc/TODO ?  If no, which ones are can we be sure that we
want to keep?  And which ones can we be sure that we want to remove?

I was able to find the following commands that are *not* mentioned in
the TODO:

- artist-submit-bug-report
- ediff-submit-report
- ps-mode-submit-bug-report
- reftex-report-bug
- vera-submit-bug-report
- verilog-submit-bug-report
- vhdl-submit-bug-report
- viper-submit-report        [obsolete package]

Should we also add them to the TODO, or is there a reason that they
have not been included?

Finally, the attached patch contains cleanups of things that already
seems to be removed, for example the `report-calc-bug' command that
has already been removed.

---

After having written the above message, I found this previous
discussion from 2008:

https://lists.gnu.org/archive/html/emacs-devel/2008-02/msg02740.html

This made me even more unsure as to what the current status is.
Is this TODO still applicable, and if so to what extent?

Thanks,
Stefan Kangas

[-- Attachment #1.2: Type: text/html, Size: 1914 bytes --]

[-- Attachment #2: 0001-Cleanup-of-TODO-to-prefer-report-emacs-bug.patch --]
[-- Type: text/x-patch, Size: 4038 bytes --]

From 2eb7fa0ea31a0b53f8fd6e80e793e40d7c697252 Mon Sep 17 00:00:00 2001
From: Stefan Kangas <stefankangas@gmail.com>
Date: Sun, 26 May 2019 18:08:01 +0200
Subject: [PATCH] Cleanup of TODO to prefer report-emacs-bug

* etc/TODO: Remove already completed removal of `report-calc-bug'.
* lisp/calc/calc.el: Remove any mention of `report-calc-bug'.
* lisp/epg-config.el: Redefine `epg-bug-report-address' as obsolete
variable alias for `report-emacs-bug-address'.
* lisp/expand.el: Remove any mention of `expand-submit-report'.
* lisp/obsolete/fast-lock.el: Remove commented out code for
`fast-lock-submit-bug-report'.
---
 etc/TODO                   |  1 -
 lisp/calc/calc.el          |  5 ++---
 lisp/epg-config.el         |  4 ++--
 lisp/expand.el             |  3 ---
 lisp/obsolete/fast-lock.el | 17 -----------------
 5 files changed, 4 insertions(+), 26 deletions(-)

diff --git a/etc/TODO b/etc/TODO
index dc594a007e..fe2e583a38 100644
--- a/etc/TODO
+++ b/etc/TODO
@@ -202,7 +202,6 @@ https://lists.gnu.org/r/emacs-devel/2007-04/msg00684.html
 Change them to use report-emacs-bug.
 *** Related functions:
 **** gnus-bug
-**** report-calc-bug
 **** org-submit-bug-report
 **** lm-report-bug
 **** tramp-bug
diff --git a/lisp/calc/calc.el b/lisp/calc/calc.el
index 35f13f9656..1496a741ab 100644
--- a/lisp/calc/calc.el
+++ b/lisp/calc/calc.el
@@ -37,13 +37,12 @@
 ;; work for the foreseeable future.
 ;;
 ;; Bug reports and suggestions are always welcome!  (Type M-x
-;; report-calc-bug to send them).
+;; report-emacs-bug to send them).
 
 ;; All functions, macros, and Lisp variables defined here begin with one
 ;; of the prefixes "math", "Math", or "calc", with the exceptions of
 ;; "full-calc", "full-calc-keypad", "another-calc", "quick-calc",
-;; "report-calc-bug", and "defmath".  User-accessible variables begin
-;; with "var-".
+;; and "defmath".  User-accessible variables begin with "var-".
 
 ;;; TODO:
 
diff --git a/lisp/epg-config.el b/lisp/epg-config.el
index 4502f90874..bb323e54fa 100644
--- a/lisp/epg-config.el
+++ b/lisp/epg-config.el
@@ -31,8 +31,8 @@ epg-package-name
 (defconst epg-version-number "1.0.0"
   "Version number of this package.")
 
-(defconst epg-bug-report-address "ueno@unixuser.org"
-  "Report bugs to this address.")
+(define-obsolete-variable-alias 'epg-bug-report-address
+  'report-emacs-bug-address "27.1")
 
 (defgroup epg ()
   "Interface to the GNU Privacy Guard (GnuPG)."
diff --git a/lisp/expand.el b/lisp/expand.el
index 0c4d343090..da76effc26 100644
--- a/lisp/expand.el
+++ b/lisp/expand.el
@@ -66,9 +66,6 @@
 ;;                  Jerome Santini <santini@chambord.univ-orleans.fr>,
 ;;                  Jari Aalto <jaalto@tre.tele.nokia.fi>.
 ;;
-;;   Please send me a word to give me your feeling about this feature or
-;; to explain me how you use it (your expansions table for example) using
-;; the function expand-submit-report.
 ;;; Code:
 \f
 ;;; Constants:
diff --git a/lisp/obsolete/fast-lock.el b/lisp/obsolete/fast-lock.el
index b8d58fa13c..9ae6d91bde 100644
--- a/lisp/obsolete/fast-lock.el
+++ b/lisp/obsolete/fast-lock.el
@@ -214,23 +214,6 @@ font-lock-face-list
                     (setq faces (cdr faces))))
            faces)))))
 
-;;(defun fast-lock-submit-bug-report ()
-;;  "Submit via mail a bug report on fast-lock.el."
-;;  (interactive)
-;;  (let ((reporter-prompt-for-summary-p t))
-;;    (reporter-submit-bug-report "simon@gnu.org" "fast-lock 3.14"
-;;     '(fast-lock-cache-directories fast-lock-minimum-size
-;;       fast-lock-save-others fast-lock-save-events fast-lock-save-faces
-;;       fast-lock-verbose)
-;;     nil nil
-;;     (concat "Hi Si.,
-;;
-;;I want to report a bug.  I've read the `Bugs' section of `Info' on Emacs, so I
-;;know how to make a clear and unambiguous report.  To reproduce the bug:
-;;
-;;Start a fresh editor via `" invocation-name " -no-init-file -no-site-file'.
-;;In the `*scratch*' buffer, evaluate:"))))
-
 (defgroup fast-lock nil
   "Font Lock support mode to cache fontification."
   :load 'fast-lock
-- 
2.11.0

Re: Status of TODO remove obsolete bug-reporting commando

[Alan Mackenzie]

Hello, Stefan.

On Sun, May 26, 2019 at 18:30:56 +0200, Stefan Kangas wrote:
> I've been looking into the following TODO:

> > ** Check for any included packages that define obsolete bug-reporting
> commands.
> > Change them to use report-emacs-bug.
> > *** Related functions:
> > **** gnus-bug
> > **** report-calc-bug
> > **** org-submit-bug-report
> > **** lm-report-bug
> > **** tramp-bug
> > **** c-submit-bug-report
> > [Do all of them need changing?]

> The final question leaves the prospective contributor in some doubt. I
> think the first step is to clarify what it is that should be done.

> First: Do all of them need changing?  If yes, should we remove that
> question in etc/TODO ?  If no, which ones are can we be sure that we
> want to keep?  And which ones can we be sure that we want to remove?

Please keep c-submit-bug-report.  It is bound to C-c C-b in CC Mode
modes, and dumps (a substantial part of) CC Mode's configuration when
executed.

[ .... ]

-- 
Alan Mackenzie (Nuremberg, Germany).

Re: Status of TODO remove obsolete bug-reporting commando

[Michael Albinus]

Alan Mackenzie <acm@muc.de> writes:

Hi Stefan,

>> First: Do all of them need changing?  If yes, should we remove that
>> question in etc/TODO ?  If no, which ones are can we be sure that we
>> want to keep?  And which ones can we be sure that we want to remove?
>
> Please keep c-submit-bug-report.  It is bound to C-c C-b in CC Mode
> modes, and dumps (a substantial part of) CC Mode's configuration when
> executed.

Something similar for tramp-bug. It carries all those Tramp debug buffers.

Best regards, Michael.

Re: Status of TODO remove obsolete bug-reporting commando

[Stefan Monnier]

> I've been looking into the following TODO:

Thanks.

> The final question leaves the prospective contributor in some doubt. I
> think the first step is to clarify what it is that should be done.

I consider it to be the main step ;-)

> First: Do all of them need changing?

That's one half of the question.

> I was able to find the following commands that are *not* mentioned in
> the TODO:

That's the other half.

> - artist-submit-bug-report
> - ediff-submit-report
> - ps-mode-submit-bug-report
> - reftex-report-bug
> - vera-submit-bug-report
> - verilog-submit-bug-report
> - vhdl-submit-bug-report
> - viper-submit-report        [obsolete package]
>
> Should we also add them to the TODO, or is there a reason that they
> have not been included?

Because we noone had looked into it yet.

As for which ones to keep and which ones to remove, we can start by
removing all those where there is no maintainer any more (i.e. the
maintainer is "us").

For those where it's unclear, we should try and contact the maintainer
to see his opinion.  If you can't get an answer (typically because none
of the email addresses one can find work any more), then we can change
the maintainer to "emacs-devel@gnu.org" (but make sure the
non-answering previous maintainer is listed in "Author:", so we don't
lose track of his past role).

> Finally, the attached patch contains cleanups of things that already
> seems to be removed, for example the `report-calc-bug' command that
> has already been removed.

Thanks, looks good, installed,


        Stefan