emacsbug.el 11.5 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, 2006, 2007, 2008, 2009  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
;; This file is part of GNU Emacs.

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

;; 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
23
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
24

25 26
;;; Commentary:

27
;; `M-x report-emacs-bug' starts an email note to the Emacs maintainers
Glenn Morris's avatar
Glenn Morris committed
28 29 30
;; describing a problem.  You need to be able to send mail from Emacs
;; to complete the process.  Alternatively, compose the bug report in
;; Emacs then paste it into your normal mail client.
31

Eric S. Raymond's avatar
Eric S. Raymond committed
32
;;; Code:
Joseph Arceneaux's avatar
Joseph Arceneaux committed
33

34 35
(require 'sendmail)

Richard M. Stallman's avatar
Richard M. Stallman committed
36 37 38 39 40
(defgroup emacsbug nil
  "Sending Emacs bug reports."
  :group 'maint
  :group 'mail)

41
(defcustom report-emacs-bug-address "bug-gnu-emacs@gnu.org"
Glenn Morris's avatar
Glenn Morris committed
42
  "Address of mailing list for GNU Emacs bugs."
43 44
  :group 'emacsbug
  :type 'string)
45

46
(defcustom report-emacs-bug-pretest-address "emacs-pretest-bug@gnu.org"
Glenn Morris's avatar
Glenn Morris committed
47
  "Address of mailing list for GNU Emacs pretest bugs."
48 49
  :group 'emacsbug
  :type 'string)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
50

Richard M. Stallman's avatar
Richard M. Stallman committed
51
(defcustom report-emacs-bug-no-confirmation nil
Glenn Morris's avatar
Glenn Morris committed
52
  "If non-nil, suppress the confirmations asked for the sake of novice users."
Richard M. Stallman's avatar
Richard M. Stallman committed
53 54 55 56
  :group 'emacsbug
  :type 'boolean)

(defcustom report-emacs-bug-no-explanations nil
Glenn Morris's avatar
Glenn Morris committed
57
  "If non-nil, suppress the explanations given for the sake of novice users."
Richard M. Stallman's avatar
Richard M. Stallman committed
58 59
  :group 'emacsbug
  :type 'boolean)
60

Glenn Morris's avatar
Glenn Morris committed
61 62 63 64 65 66
;; User options end here.


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

67 68 69
(declare-function x-server-vendor "xfns.c" (&optional terminal))
(declare-function x-server-version "xfns.c" (&optional terminal))

Jim Blandy's avatar
Jim Blandy committed
70
;;;###autoload
71
(defun report-emacs-bug (topic &optional recent-keys)
Jim Blandy's avatar
Jim Blandy committed
72
  "Report a bug in GNU Emacs.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
73
Prompts for bug subject.  Leaves you in a mail buffer."
74 75 76
  ;; 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: "))))
77 78
  ;; The syntax `version;' is preferred to `[version]' because the
  ;; latter could be mistakenly stripped by mailing software.
79 80 81 82 83 84 85 86 87 88
  (if (eq system-type 'ms-dos)
      (setq topic (concat emacs-version "; " topic))
    (when (string-match "^\\(\\([.0-9]+\\)*\\)\\.[0-9]+$" emacs-version)
      (setq topic (concat (match-string 1 emacs-version) "; " topic))))
  ;; If there are four numbers in emacs-version (three for MS-DOS),
  ;; this is a pretest version.
  (let* ((pretest-p (string-match (if (eq system-type 'ms-dos)
				      "\\..*\\."
				    "\\..*\\..*\\.")
				  emacs-version))
89 90 91 92 93 94 95 96 97
	 (from-buffer (current-buffer))
	 (reporting-address (if pretest-p
				report-emacs-bug-pretest-address
			      report-emacs-bug-address))
	 ;; Put these properties on semantically-void text.
	 (prompt-properties '(field emacsbug-prompt
				    intangible but-helpful
				    rear-nonsticky t))
	 user-point message-end-point)
98
    (setq message-end-point
99
	  (with-current-buffer (get-buffer-create "*Messages*")
100
	    (point-max-marker)))
101
    (compose-mail reporting-address
102 103 104
		  topic)
    ;; The rest of this does not execute
    ;; if the user was asked to confirm and said no.
105 106 107 108 109
    (rfc822-goto-eoh)
    (forward-line 1)

    (let ((signature (buffer-substring (point) (point-max))))
      (delete-region (point) (point-max))
110 111
      (insert signature)
      (backward-char (length signature)))
Richard M. Stallman's avatar
Richard M. Stallman committed
112 113
    (unless report-emacs-bug-no-explanations
      ;; Insert warnings for novice users.
114 115 116 117 118
      (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)))
119
      (insert "\nPlease write in ")
Richard M. Stallman's avatar
Richard M. Stallman committed
120 121 122
      (let ((pos (point)))
	(insert "English")
	(put-text-property pos (point) 'face 'highlight))
123 124
      (insert " if possible, because the Emacs maintainers
usually do not have translators to read other languages for them.\n\n")
125
      (insert (format "Your bug report will be posted to the %s mailing list"
126
		      reporting-address))
127 128 129
      (if pretest-p
	  (insert ".\n\n")
	(insert ",\nand to the gnu.emacs.bug news group.\n\n")))
130

131
    (insert "Please describe exactly what actions triggered the bug\n"
132 133
	    "and the precise symptoms of the bug.  If you can, give\n"
	    "a recipe starting from `emacs -Q':\n\n")
134 135
    (add-text-properties (point) (save-excursion (mail-text) (point))
                         prompt-properties)
136 137

    (setq user-point (point))
138 139
    (insert "\n\n")

140
    (insert "If Emacs crashed, and you have the Emacs process in the gdb debugger,\n"
141 142 143 144 145
	    "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)
146 147
	  (insert "For information about debugging Emacs, please read the file\n"
		  debug-file ".\n")))
148
    (add-text-properties (1+ user-point) (point) prompt-properties)
149

150
    (insert "\n\nIn " (emacs-version) "\n")
151
    (if (fboundp 'x-server-vendor)
152
	(condition-case nil
153 154 155
            ;; This is used not only for X11 but also W32 and others.
	    (insert "Windowing system distributor `" (x-server-vendor)
                    "', version "
156 157
		    (mapconcat 'number-to-string (x-server-version) ".") "\n")
	  (error t)))
158 159 160
    (if (and system-configuration-options
	     (not (equal system-configuration-options "")))
	(insert "configured using `configure "
161
		system-configuration-options "'\n\n"))
162
    (insert "Important settings:\n")
163
    (mapc
164 165 166
     '(lambda (var)
	(insert (format "  value of $%s: %s\n" var (getenv var))))
     '("LC_ALL" "LC_COLLATE" "LC_CTYPE" "LC_MESSAGES"
167
       "LC_MONETARY" "LC_NUMERIC" "LC_TIME" "LANG" "XMODIFIERS"))
168
    (insert (format "  locale-coding-system: %s\n" locale-coding-system))
169 170
    (insert (format "  default enable-multibyte-characters: %s\n"
		    (default-value 'enable-multibyte-characters)))
171
    (insert "\n")
172
    (insert (format "Major mode: %s\n"
173 174 175
		    (format-mode-line
                     (buffer-local-value 'mode-name from-buffer)
                     nil nil from-buffer)))
176 177 178
    (insert "\n")
    (insert "Minor modes in effect:\n")
    (dolist (mode minor-mode-list)
179 180 181
      (and (boundp mode) (buffer-local-value mode from-buffer)
	   (insert (format "  %s: %s\n" mode
			   (buffer-local-value mode from-buffer)))))
182
    (insert "\n")
183
    (insert "Recent input:\n")
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208
    (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))))
209 210 211 212 213 214 215 216 217 218 219 220
    ;; After Recent messages, to avoid the messages produced by
    ;; list-load-path-shadows.
    (unless (looking-back "\n")
      (insert "\n"))
    (insert "\n")
    (insert "Load-path shadows:\n")
    (message "Checking for load-path shadows...")
    (let ((shadows (list-load-path-shadows t)))
      (message "Checking for load-path shadows...done")
      (insert (if (zerop (length shadows))
                  "None found.\n"
                shadows)))
221 222 223
    (insert (format "\nFeatures:\n%s\n" features))
    (fill-region (line-beginning-position 0) (point))
    ;; This is so the user has to type something in order to send easily.
224 225
    (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
    (define-key (current-local-map) "\C-c\C-i" 'report-emacs-bug-info)
226 227
    (unless report-emacs-bug-no-explanations
      (with-output-to-temp-buffer "*Bug Help*"
228
	(princ "While in the mail buffer:\n\n")
229 230
	(if (eq mail-user-agent 'sendmail-user-agent)
	    (princ (substitute-command-keys
231
		    "  Type \\[mail-send-and-exit] to send the bug report.\n")))
232
	(princ (substitute-command-keys
233
		"  Type \\[kill-buffer] RET to cancel (don't send it).\n"))
234 235
	(terpri)
	(princ (substitute-command-keys
236 237 238 239
		"  Type \\[report-emacs-bug-info] to visit in Info the Emacs Manual section
    about when and how to write a bug report, and what
    information you should include to help fix the bug.")))
      (shrink-window-if-larger-than-buffer (get-buffer-window "*Bug Help*")))
240 241 242 243 244 245 246 247 248
    ;; 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)))
249

250 251 252
(defun report-emacs-bug-info ()
  "Go to the Info node on reporting Emacs bugs."
  (interactive)
Glenn Morris's avatar
Glenn Morris committed
253
  (info "(emacs)Bugs"))
254

255 256
(defun report-emacs-bug-hook ()
  (save-excursion
257 258 259 260 261 262 263 264
    (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")))
265 266

    ;; Check the buffer contents and reject non-English letters.
267 268 269 270
    (save-excursion
      (goto-char (point-min))
      (skip-chars-forward "\0-\177")
      (if (not (eobp))
Richard M. Stallman's avatar
Richard M. Stallman committed
271
	  (if (or report-emacs-bug-no-confirmation
272
		  (y-or-n-p "Convert non-ASCII letters to hexadecimal? "))
273 274 275 276
	      (while (progn (skip-chars-forward "\0-\177")
			    (not (eobp)))
		(let ((ch (following-char)))
		  (delete-char 1)
277
		  (insert (format "=%02x" ch)))))))
278 279

    ;; The last warning for novice users.
Richard M. Stallman's avatar
Richard M. Stallman committed
280
    (if (or report-emacs-bug-no-confirmation
281
	    (yes-or-no-p
282
	     "Send this bug report to the Emacs maintainers? "))
283 284 285 286 287 288 289 290 291 292
	;; 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 "\
293 294
You invoked the command M-x report-emacs-bug,
but you decided not to mail the bug report to the Emacs maintainers.
295

296 297 298 299
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"))
300 301 302

    ;; Unclutter
    (mail-text)
303 304 305 306
    (let ((pos (1- (point))))
      (while (setq pos (text-property-any pos (point-max)
                                          'field 'emacsbug-prompt))
        (delete-region pos (field-end (1+ pos)))))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
307

308 309
(provide 'emacsbug)

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