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

3
;; Copyright (C) 1985, 1994, 1997, 1998 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
9 10 11 12 13
;; 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
14
;; the Free Software Foundation; either version 2, or (at your option)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
15 16 17 18 19 20 21 22
;; 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
23 24 25
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
26

27 28 29 30 31
;;; Commentary:

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

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

;; >> 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.

38 39
(require 'sendmail)

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

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

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

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

Richard M. Stallman's avatar
Richard M. Stallman committed
58 59 60 61 62 63 64 65 66
(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)
67

Jim Blandy's avatar
Jim Blandy committed
68
;;;###autoload
69
(defun report-emacs-bug (topic &optional recent-keys)
Jim Blandy's avatar
Jim Blandy committed
70
  "Report a bug in GNU Emacs.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
71
Prompts for bug subject.  Leaves you in a mail buffer."
72 73 74
  ;; 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: "))))
75 76 77 78 79 80 81 82
  (let (user-point message-end-point)
    (setq message-end-point
	  (with-current-buffer (get-buffer "*Messages*")
	    (point-max-marker)))
    (compose-mail (if (string-match "\\..*\\..*\\." emacs-version)
		      ;; If there are four numbers in emacs-version,
		      ;; this is a pretest version.
		      report-emacs-bug-pretest-address
83
		    report-emacs-bug-address)
84 85 86
		  topic)
    ;; The rest of this does not execute
    ;; if the user was asked to confirm and said no.
87 88 89 90 91 92 93
    (rfc822-goto-eoh)
    (forward-line 1)

    (let ((signature (buffer-substring (point) (point-max))))
      ;; Discourage users to write non-English text.
      (set-buffer-multibyte nil)
      (delete-region (point) (point-max))
94 95
      (insert signature)
      (backward-char (length signature)))
Richard M. Stallman's avatar
Richard M. Stallman committed
96 97 98 99
    (unless report-emacs-bug-no-explanations
      ;; Insert warnings for novice users.
      (insert "This bug report will be sent to the Free Software Foundation,\n")
      (let ((pos (point)))
100
	(insert "not to your local site managers!")
Richard M. Stallman's avatar
Richard M. Stallman committed
101 102 103 104 105 106 107
	(put-text-property pos (point) 'face 'highlight))
      (insert "\nPlease write in ")
      (let ((pos (point)))
	(insert "English")
	(put-text-property pos (point) 'face 'highlight))
      (insert ", because the Emacs maintainers do not have
translators to read other languages for them.\n\n"))
108

109 110 111 112 113
    (insert "In " (emacs-version) "\n")
    (if (and system-configuration-options
	     (not (equal system-configuration-options "")))
	(insert "configured using `configure "
		system-configuration-options "'\n"))
114 115
    (insert "Important settings:\n")
    (insert (format "  value of $LC_ALL: %s\n" (getenv "LC_ALL")))
116
    (insert (format "  value of $LC_CTYPE: %s\n" (getenv "LC_CTYPE")))
117 118 119 120
    (insert (format "  value of $LANG: %s\n" (getenv "LANG")))
    (insert (format "  locale-coding-system: %s\n" locale-coding-system))
    (insert (format "  default-enable-multibyte-characters: %s\n"
		    default-enable-multibyte-characters))
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
    (insert "\n")
    (insert "Please describe exactly what actions triggered the bug\n"
	    "and the precise symptoms of the bug:\n\n") 
    (setq user-point (point))
    (insert "\n\n\n"
	    "Recent input:\n")
    (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)
156 157 158 159 160 161 162 163 164 165
    (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
166 167
about when and how to write a bug report,
and what information to supply so that the bug can be fixed.
168
Type SPC to scroll through this section and its subsections."))))
169 170 171 172 173 174 175 176 177
    ;; 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)))
178

179 180 181 182 183 184 185 186
(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"))

187 188 189 190 191 192 193 194
(defun report-emacs-bug-hook ()
  (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))
195 196 197
	(error "No text entered in bug report"))

    ;; Check the buffer contents and reject non-English letters.
198 199 200 201
    (save-excursion
      (goto-char (point-min))
      (skip-chars-forward "\0-\177")
      (if (not (eobp))
Richard M. Stallman's avatar
Richard M. Stallman committed
202
	  (if (or report-emacs-bug-no-confirmation
203
		  (y-or-n-p "Convert non-ASCII letters to hexadecimal? "))
204 205 206 207
	      (while (progn (skip-chars-forward "\0-\177")
			    (not (eobp)))
		(let ((ch (following-char)))
		  (delete-char 1)
208
		  (insert (format "=%02x" ch)))))))
209 210

    ;; The last warning for novice users.
Richard M. Stallman's avatar
Richard M. Stallman committed
211
    (if (or report-emacs-bug-no-confirmation
212
	    (yes-or-no-p
213
	     "Send this bug report to the Emacs maintainers? "))
214 215 216 217 218 219 220 221 222 223
	;; 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 "\
224 225
You invoked the command M-x report-emacs-bug,
but you decided not to mail the bug report to the Emacs maintainers.
226

227 228 229 230
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"))
231
    ))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
232

233 234
(provide 'emacsbug)

Eric S. Raymond's avatar
Eric S. Raymond committed
235
;;; emacsbug.el ends here