1 ;;; emacsbug.el --- command to report Emacs bugs to appropriate mailing list
3 ;; Copyright (C) 1985, 1994, 1997, 1998 Free Software Foundation, Inc.
5 ;; Author: K. Shane Hartman
7 ;; Keywords: maint mail
9 ;; Not fully installed because it can work only on Internet hosts.
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
25 ;; Boston, MA 02111-1307, USA.
29 ;; `M-x report-emacs-bug ' starts an email note to the Emacs maintainers
30 ;; describing a problem. Here's how it's done...
34 ;; >> This should be an address which is accessible to your machine,
35 ;; >> otherwise you can't use this file. It will only work on the
36 ;; >> internet with this address.
40 (defgroup emacsbug nil
41 "Sending Emacs bug reports."
45 (defcustom report-emacs-bug-address
"bug-gnu-emacs@gnu.org"
46 "*Address of mailing list for GNU Emacs bugs."
50 (defcustom report-emacs-bug-pretest-address
"emacs-pretest-bug@gnu.org"
51 "*Address of mailing list for GNU Emacs pretest bugs."
55 (defvar report-emacs-bug-orig-text nil
56 "The automatically-created initial text of bug report.")
58 (defcustom report-emacs-bug-no-confirmation nil
59 "*If non-nil, suppress the confirmations asked for the sake of novice users."
63 (defcustom report-emacs-bug-no-explanations nil
64 "*If non-nil, suppress the explanations given for the sake of novice users."
69 (defun report-emacs-bug (topic &optional recent-keys
)
70 "Report a bug in GNU Emacs.
71 Prompts for bug subject. Leaves you in a mail buffer."
72 ;; This strange form ensures that (recent-keys) is the value before
73 ;; the bug subject string is read.
74 (interactive (reverse (list (recent-keys) (read-string "Bug Subject: "))))
75 ;; If there are four numbers in emacs-version, this is a pretest
77 (let ((pretest-p (string-match "\\..*\\..*\\." emacs-version
))
78 user-point message-end-point
)
79 (setq message-end-point
80 (with-current-buffer (get-buffer-create "*Messages*")
82 (compose-mail (if pretest-p
83 report-emacs-bug-pretest-address
84 report-emacs-bug-address
)
86 ;; The rest of this does not execute
87 ;; if the user was asked to confirm and said no.
91 (let ((signature (buffer-substring (point) (point-max))))
92 (delete-region (point) (point-max))
94 (backward-char (length signature
)))
95 (unless report-emacs-bug-no-explanations
96 ;; Insert warnings for novice users.
97 (insert "This bug report will be sent to the Free Software Foundation,\n")
99 (insert "not to your local site managers!")
100 (put-text-property pos
(point) 'face
'highlight
))
101 (insert "\nPlease write in ")
104 (put-text-property pos
(point) 'face
'highlight
))
105 (insert ", because the Emacs maintainers do not have
106 translators to read other languages for them.\n\n")
107 (insert (format "Your bug report will be posted to the %s mailing list"
109 report-emacs-bug-pretest-address
110 report-emacs-bug-address
)))
113 (insert ",\nand to the gnu.emacs.bug news group.\n\n")))
115 (insert "In " (emacs-version) "\n")
116 (if (and system-configuration-options
117 (not (equal system-configuration-options
"")))
118 (insert "configured using `configure "
119 system-configuration-options
"'\n"))
120 (insert "Important settings:\n")
123 (insert (format " value of $%s: %s\n" var
(getenv var
))))
124 '("LC_ALL" "LC_COLLATE" "LC_CTYPE" "LC_MESSAGES"
125 "LC_MONETARY" "LC_NUMERIC" "LC_TIME" "LANG"))
126 (insert (format " locale-coding-system: %s\n" locale-coding-system
))
127 (insert (format " default-enable-multibyte-characters: %s\n"
128 default-enable-multibyte-characters
))
130 (insert "Please describe exactly what actions triggered the bug\n"
131 "and the precise symptoms of the bug:\n\n")
132 (setq user-point
(point))
135 (let ((before-keys (point)))
136 (insert (mapconcat (lambda (key)
137 (if (or (integerp key
)
140 (single-key-description key
)
141 (prin1-to-string key nil
)))
142 (or recent-keys
(recent-keys))
145 (narrow-to-region before-keys
(point))
146 (goto-char before-keys
)
147 (while (progn (move-to-column 50) (not (eobp)))
148 (search-forward " " nil t
)
150 (let ((message-buf (get-buffer "*Messages*")))
153 (end-pos message-end-point
))
154 (with-current-buffer message-buf
157 (setq beg-pos
(point)))
158 (insert "\n\nRecent messages:\n")
159 (insert-buffer-substring message-buf beg-pos end-pos
))))
160 ;; This is so the user has to type something
161 ;; in order to send easily.
162 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
163 (define-key (current-local-map) "\C-c\C-i" 'report-emacs-bug-info
)
164 (unless report-emacs-bug-no-explanations
165 (with-output-to-temp-buffer "*Bug Help*"
166 (if (eq mail-user-agent
'sendmail-user-agent
)
167 (princ (substitute-command-keys
168 "Type \\[mail-send-and-exit] to send the bug report.\n")))
169 (princ (substitute-command-keys
170 "Type \\[kill-buffer] RET to cancel (don't send it).\n"))
172 (princ (substitute-command-keys
173 "Type \\[report-emacs-bug-info] to visit in Info the Emacs Manual section
174 about when and how to write a bug report,
175 and what information to supply so that the bug can be fixed.
176 Type SPC to scroll through this section and its subsections."))))
177 ;; Make it less likely people will send empty messages.
178 (make-local-variable 'mail-send-hook
)
179 (add-hook 'mail-send-hook
'report-emacs-bug-hook
)
181 (goto-char (point-max))
182 (skip-chars-backward " \t\n")
183 (make-local-variable 'report-emacs-bug-orig-text
)
184 (setq report-emacs-bug-orig-text
(buffer-substring (point-min) (point))))
185 (goto-char user-point
)))
187 (defun report-emacs-bug-info ()
188 "Go to the Info node on reporting Emacs bugs."
193 (Info-goto-node "Bugs"))
195 (defun report-emacs-bug-hook ()
197 (goto-char (point-max))
198 (skip-chars-backward " \t\n")
199 (if (and (= (- (point) (point-min))
200 (length report-emacs-bug-orig-text
))
201 (equal (buffer-substring (point-min) (point))
202 report-emacs-bug-orig-text
))
203 (error "No text entered in bug report"))
205 ;; Check the buffer contents and reject non-English letters.
207 (goto-char (point-min))
208 (skip-chars-forward "\0-\177")
210 (if (or report-emacs-bug-no-confirmation
211 (y-or-n-p "Convert non-ASCII letters to hexadecimal? "))
212 (while (progn (skip-chars-forward "\0-\177")
214 (let ((ch (following-char)))
216 (insert (format "=%02x" ch
)))))))
218 ;; The last warning for novice users.
219 (if (or report-emacs-bug-no-confirmation
221 "Send this bug report to the Emacs maintainers? "))
222 ;; Just send the current mail.
224 (goto-char (point-min))
225 (if (search-forward "To: ")
228 (delete-region pos
(point))))
229 (kill-local-variable 'mail-send-hook
)
230 (with-output-to-temp-buffer "*Bug Help*"
231 (princ (substitute-command-keys "\
232 You invoked the command M-x report-emacs-bug,
233 but you decided not to mail the bug report to the Emacs maintainers.
235 If you want to mail it to someone else instead,
236 please insert the proper e-mail address after \"To: \",
237 and send the mail again using \\[mail-send-and-exit].")))
238 (error "M-x report-emacs-bug was cancelled, please read *Bug Help* buffer"))
243 (if (re-search-forward (concat "^In " (emacs-version)) nil t
)
244 (delete-region p
(match-beginning 0))))
245 (re-search-forward "Please describe.+\n.+precise symptoms.+bug:\n*"
247 (replace-match "Symptoms:\n")))
251 ;;; emacsbug.el ends here