emacsbug.el 10.1 KB
Newer Older
1
;;; emacsbug.el --- command to report Emacs bugs to appropriate mailing list
Eric S. Raymond's avatar
Eric S. Raymond committed
2

3 4
;; Copyright (C) 1985, 1994, 1997, 1998, 2000, 2001, 2002, 2003,
;;   2004, 2005 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

Eric S. Raymond's avatar
Eric S. Raymond committed
6
;; Author: K. Shane Hartman
Eric S. Raymond's avatar
Eric S. Raymond committed
7
;; Maintainer: FSF
Richard M. Stallman's avatar
Richard M. Stallman committed
8
;; Keywords: maint mail
Eric S. Raymond's avatar
Eric S. Raymond committed
9

Joseph Arceneaux's avatar
Joseph Arceneaux committed
10 11 12 13 14
;; Not fully installed because it can work only on Internet hosts.
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
Eric S. Raymond's avatar
Eric S. Raymond committed
15
;; the Free Software Foundation; either version 2, or (at your option)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
16 17 18 19 20 21 22 23
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
24
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
25 26
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
27

28 29
;;; Commentary:

30
;; `M-x report-emacs-bug' starts an email note to the Emacs maintainers
31 32
;; describing a problem.  Here's how it's done...

Eric S. Raymond's avatar
Eric S. Raymond committed
33
;;; Code:
Joseph Arceneaux's avatar
Joseph Arceneaux committed
34 35 36 37 38

;; >> This should be an address which is accessible to your machine,
;; >> otherwise you can't use this file.  It will only work on the
;; >> internet with this address.

39 40
(require 'sendmail)

Richard M. Stallman's avatar
Richard M. Stallman committed
41 42 43 44 45
(defgroup emacsbug nil
  "Sending Emacs bug reports."
  :group 'maint
  :group 'mail)

46
(defcustom report-emacs-bug-address "bug-gnu-emacs@gnu.org"
47 48 49
  "*Address of mailing list for GNU Emacs bugs."
  :group 'emacsbug
  :type 'string)
50

51
(defcustom report-emacs-bug-pretest-address "emacs-pretest-bug@gnu.org"
52 53 54
  "*Address of mailing list for GNU Emacs pretest bugs."
  :group 'emacsbug
  :type 'string)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
55

56 57 58
(defvar report-emacs-bug-orig-text nil
  "The automatically-created initial text of bug report.")

59 60 61
(defvar report-emacs-bug-text-prompt nil
  "The automatically-created initial prompt of bug report.")

Richard M. Stallman's avatar
Richard M. Stallman committed
62 63 64 65 66 67 68 69 70
(defcustom report-emacs-bug-no-confirmation nil
  "*If non-nil, suppress the confirmations asked for the sake of novice users."
  :group 'emacsbug
  :type 'boolean)

(defcustom report-emacs-bug-no-explanations nil
  "*If non-nil, suppress the explanations given for the sake of novice users."
  :group 'emacsbug
  :type 'boolean)
71

Jim Blandy's avatar
Jim Blandy committed
72
;;;###autoload
73
(defun report-emacs-bug (topic &optional recent-keys)
Jim Blandy's avatar
Jim Blandy committed
74
  "Report a bug in GNU Emacs.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
75
Prompts for bug subject.  Leaves you in a mail buffer."
76 77 78
  ;; This strange form ensures that (recent-keys) is the value before
  ;; the bug subject string is read.
  (interactive (reverse (list (recent-keys) (read-string "Bug Subject: "))))
79 80
  ;; If there are four numbers in emacs-version, this is a pretest
  ;; version.
81
  (let* ((pretest-p (string-match "\\..*\\..*\\." emacs-version))
82
	(from-buffer (current-buffer))
83 84 85
	(reporting-address (if pretest-p
			       report-emacs-bug-pretest-address
			     report-emacs-bug-address))
86
	user-point prompt-beg-point message-end-point)
87
    (setq message-end-point
88
	  (with-current-buffer (get-buffer-create "*Messages*")
89
	    (point-max-marker)))
90
    (compose-mail reporting-address
91 92 93
		  topic)
    ;; The rest of this does not execute
    ;; if the user was asked to confirm and said no.
94 95 96 97 98
    (rfc822-goto-eoh)
    (forward-line 1)

    (let ((signature (buffer-substring (point) (point-max))))
      (delete-region (point) (point-max))
99 100
      (insert signature)
      (backward-char (length signature)))
101
    (setq prompt-beg-point (point))
Richard M. Stallman's avatar
Richard M. Stallman committed
102 103
    (unless report-emacs-bug-no-explanations
      ;; Insert warnings for novice users.
104 105 106 107 108 109
      (when (string-match "@gnu\\.org^" reporting-address)
	(insert "This bug report will be sent to the Free Software Foundation,\n")
	(let ((pos (point)))
	  (insert "not to your local site managers!")
	  (put-text-property pos (point) 'face 'highlight)))
	(insert "\nPlease write in ")
Richard M. Stallman's avatar
Richard M. Stallman committed
110 111 112
      (let ((pos (point)))
	(insert "English")
	(put-text-property pos (point) 'face 'highlight))
113 114
      (insert " if possible, because the Emacs maintainers
usually do not have translators to read other languages for them.\n\n")
115
      (insert (format "Your bug report will be posted to the %s mailing list"
116
		      reporting-address))
117 118 119
      (if pretest-p
	  (insert ".\n\n")
	(insert ",\nand to the gnu.emacs.bug news group.\n\n")))
120

121 122 123 124 125 126 127
    (insert "Please describe exactly what actions triggered the bug\n"
	    "and the precise symptoms of the bug:")
    (setq report-emacs-bug-text-prompt
	  (buffer-substring prompt-beg-point (point)))

    (insert "\n\n")
    (setq user-point (point))
128 129 130 131 132 133 134 135 136 137
    (insert "\n\n")

    (insert "If emacs crashed, and you have the emacs process in the gdb debugger,\n"
	    "please include the output from the following gdb commands:\n"
	    "    `bt full' and `xbacktrace'.\n")

    (let ((debug-file (expand-file-name "DEBUG" data-directory)))
      (if (file-readable-p debug-file)
	(insert "If you would like to further debug the crash, please read the file\n"
		debug-file " for instructions.\n")))
138

139
    (insert "\n\nIn " (emacs-version) "\n")
140
    (if (fboundp 'x-server-vendor)
141
	(condition-case nil
142
	    (insert "X server distributor `" (x-server-vendor) "', version "
143 144
		    (mapconcat 'number-to-string (x-server-version) ".") "\n")
	  (error t)))
145 146 147
    (if (and system-configuration-options
	     (not (equal system-configuration-options "")))
	(insert "configured using `configure "
148
		system-configuration-options "'\n\n"))
149
    (insert "Important settings:\n")
150 151 152 153 154
    (mapcar
     '(lambda (var)
	(insert (format "  value of $%s: %s\n" var (getenv var))))
     '("LC_ALL" "LC_COLLATE" "LC_CTYPE" "LC_MESSAGES"
       "LC_MONETARY" "LC_NUMERIC" "LC_TIME" "LANG"))
155 156 157
    (insert (format "  locale-coding-system: %s\n" locale-coding-system))
    (insert (format "  default-enable-multibyte-characters: %s\n"
		    default-enable-multibyte-characters))
158
    (insert "\n")
159 160
    (insert (format "Major mode: %s\n"
		    (buffer-local-value 'mode-name from-buffer)))
161 162 163
    (insert "\n")
    (insert "Minor modes in effect:\n")
    (dolist (mode minor-mode-list)
164 165 166
      (and (boundp mode) (buffer-local-value mode from-buffer)
	   (insert (format "  %s: %s\n" mode
			   (buffer-local-value mode from-buffer)))))
167
    (insert "\n")
168
    (insert "Recent input:\n")
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
    (let ((before-keys (point)))
      (insert (mapconcat (lambda (key)
			   (if (or (integerp key)
				   (symbolp key)
				   (listp key))
			       (single-key-description key)
			     (prin1-to-string key nil)))
			 (or recent-keys (recent-keys))
			 " "))
      (save-restriction
	(narrow-to-region before-keys (point))
	(goto-char before-keys)
	(while (progn (move-to-column 50) (not (eobp)))
	  (search-forward " " nil t)
	  (insert "\n"))))
    (let ((message-buf (get-buffer "*Messages*")))
      (if message-buf
	  (let (beg-pos
		(end-pos message-end-point))
	    (with-current-buffer message-buf
	      (goto-char end-pos)
	      (forward-line -10)
	      (setq beg-pos (point)))
	    (insert "\n\nRecent messages:\n")
	    (insert-buffer-substring message-buf beg-pos end-pos))))
    ;; This is so the user has to type something
    ;; in order to send easily.
    (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
    (define-key (current-local-map) "\C-c\C-i" 'report-emacs-bug-info)
198 199 200 201 202 203 204 205 206 207
    (unless report-emacs-bug-no-explanations
      (with-output-to-temp-buffer "*Bug Help*"
	(if (eq mail-user-agent 'sendmail-user-agent)
	    (princ (substitute-command-keys
		    "Type \\[mail-send-and-exit] to send the bug report.\n")))
	(princ (substitute-command-keys
		"Type \\[kill-buffer] RET to cancel (don't send it).\n"))
	(terpri)
	(princ (substitute-command-keys
		"Type \\[report-emacs-bug-info] to visit in Info the Emacs Manual section
208 209
about when and how to write a bug report,
and what information to supply so that the bug can be fixed.
210
Type SPC to scroll through this section and its subsections."))))
211 212 213 214 215 216 217 218 219
    ;; Make it less likely people will send empty messages.
    (make-local-variable 'mail-send-hook)
    (add-hook 'mail-send-hook 'report-emacs-bug-hook)
    (save-excursion
      (goto-char (point-max))
      (skip-chars-backward " \t\n")
      (make-local-variable 'report-emacs-bug-orig-text)
      (setq report-emacs-bug-orig-text (buffer-substring (point-min) (point))))
    (goto-char user-point)))
220

221 222 223 224 225 226 227 228
(defun report-emacs-bug-info ()
  "Go to the Info node on reporting Emacs bugs."
  (interactive)
  (info)
  (Info-directory)
  (Info-menu "emacs")
  (Info-goto-node "Bugs"))

229 230
(defun report-emacs-bug-hook ()
  (save-excursion
231 232 233 234 235 236 237 238
    (save-excursion
      (goto-char (point-max))
      (skip-chars-backward " \t\n")
      (if (and (= (- (point) (point-min))
		  (length report-emacs-bug-orig-text))
	       (equal (buffer-substring (point-min) (point))
		      report-emacs-bug-orig-text))
	  (error "No text entered in bug report")))
239 240

    ;; Check the buffer contents and reject non-English letters.
241 242 243 244
    (save-excursion
      (goto-char (point-min))
      (skip-chars-forward "\0-\177")
      (if (not (eobp))
Richard M. Stallman's avatar
Richard M. Stallman committed
245
	  (if (or report-emacs-bug-no-confirmation
246
		  (y-or-n-p "Convert non-ASCII letters to hexadecimal? "))
247 248 249 250
	      (while (progn (skip-chars-forward "\0-\177")
			    (not (eobp)))
		(let ((ch (following-char)))
		  (delete-char 1)
251
		  (insert (format "=%02x" ch)))))))
252 253

    ;; The last warning for novice users.
Richard M. Stallman's avatar
Richard M. Stallman committed
254
    (if (or report-emacs-bug-no-confirmation
255
	    (yes-or-no-p
256
	     "Send this bug report to the Emacs maintainers? "))
257 258 259 260 261 262 263 264 265 266
	;; Just send the current mail.
	nil
      (goto-char (point-min))
      (if (search-forward "To: ")
	  (let ((pos (point)))
	    (end-of-line)
	    (delete-region pos (point))))
      (kill-local-variable 'mail-send-hook)
      (with-output-to-temp-buffer "*Bug Help*"
	(princ (substitute-command-keys "\
267 268
You invoked the command M-x report-emacs-bug,
but you decided not to mail the bug report to the Emacs maintainers.
269

270 271 272 273
If you want to mail it to someone else instead,
please insert the proper e-mail address after \"To: \",
and send the mail again using \\[mail-send-and-exit].")))
      (error "M-x report-emacs-bug was cancelled, please read *Bug Help* buffer"))
274 275 276

    ;; Unclutter
    (mail-text)
277 278
    (if (looking-at report-emacs-bug-text-prompt)
	(replace-match "Symptoms:"))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
279

280 281
(provide 'emacsbug)

Miles Bader's avatar
Miles Bader committed
282
;;; arch-tag: 248b6523-c3b5-4fec-9a3f-0411fafa7d49
Eric S. Raymond's avatar
Eric S. Raymond committed
283
;;; emacsbug.el ends here