1 ;;; emacsbug.el --- command to report Emacs bugs to appropriate mailing list
3 ;; Copyright (C) 1985, 1994, 1997, 1998, 2000, 2001, 2002
4 ;; Free Software Foundation, Inc.
6 ;; Author: K. Shane Hartman
8 ;; Keywords: maint mail
10 ;; Not fully installed because it can work only on Internet hosts.
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, USA.
30 ;; `M-x report-emacs-bug' starts an email note to the Emacs maintainers
31 ;; describing a problem. Here's how it's done...
35 ;; >> This should be an address which is accessible to your machine,
36 ;; >> otherwise you can't use this file. It will only work on the
37 ;; >> internet with this address.
41 (defgroup emacsbug nil
42 "Sending Emacs bug reports."
46 (defcustom report-emacs-bug-address
"bug-gnu-emacs@gnu.org"
47 "*Address of mailing list for GNU Emacs bugs."
51 (defcustom report-emacs-bug-pretest-address
"emacs-pretest-bug@gnu.org"
52 "*Address of mailing list for GNU Emacs pretest bugs."
56 (defvar report-emacs-bug-orig-text nil
57 "The automatically-created initial text of bug report.")
59 (defvar report-emacs-bug-text-prompt nil
60 "The automatically-created initial prompt of bug report.")
62 (defcustom report-emacs-bug-no-confirmation nil
63 "*If non-nil, suppress the confirmations asked for the sake of novice users."
67 (defcustom report-emacs-bug-no-explanations nil
68 "*If non-nil, suppress the explanations given for the sake of novice users."
73 (defun report-emacs-bug (topic &optional recent-keys
)
74 "Report a bug in GNU Emacs.
75 Prompts for bug subject. Leaves you in a mail buffer."
76 ;; This strange form ensures that (recent-keys) is the value before
77 ;; the bug subject string is read.
78 (interactive (reverse (list (recent-keys) (read-string "Bug Subject: "))))
79 ;; If there are four numbers in emacs-version, this is a pretest
81 (let ((pretest-p (string-match "\\..*\\..*\\." emacs-version
))
82 (from-buffer (current-buffer))
83 user-point prompt-beg-point message-end-point
)
84 (setq message-end-point
85 (with-current-buffer (get-buffer-create "*Messages*")
87 (compose-mail (if pretest-p
88 report-emacs-bug-pretest-address
89 report-emacs-bug-address
)
91 ;; The rest of this does not execute
92 ;; if the user was asked to confirm and said no.
96 (let ((signature (buffer-substring (point) (point-max))))
97 (delete-region (point) (point-max))
99 (backward-char (length signature
)))
100 (setq prompt-beg-point
(point))
101 (unless report-emacs-bug-no-explanations
102 ;; Insert warnings for novice users.
103 (insert "This bug report will be sent to the Free Software Foundation,\n")
105 (insert "not to your local site managers!")
106 (put-text-property pos
(point) 'face
'highlight
))
107 (insert "\nPlease write in ")
110 (put-text-property pos
(point) 'face
'highlight
))
111 (insert " if possible, because the Emacs maintainers
112 usually do not have translators to read other languages for them.\n\n")
113 (insert (format "Your bug report will be posted to the %s mailing list"
115 report-emacs-bug-pretest-address
116 report-emacs-bug-address
)))
119 (insert ",\nand to the gnu.emacs.bug news group.\n\n")))
121 (insert "Please describe exactly what actions triggered the bug\n"
122 "and the precise symptoms of the bug:")
123 (setq report-emacs-bug-text-prompt
124 (buffer-substring prompt-beg-point
(point)))
127 (setq user-point
(point))
130 (insert "In " (emacs-version) "\n")
131 (if (and system-configuration-options
132 (not (equal system-configuration-options
"")))
133 (insert "configured using `configure "
134 system-configuration-options
"'\n\n"))
135 (insert "Important settings:\n")
138 (insert (format " value of $%s: %s\n" var
(getenv var
))))
139 '("LC_ALL" "LC_COLLATE" "LC_CTYPE" "LC_MESSAGES"
140 "LC_MONETARY" "LC_NUMERIC" "LC_TIME" "LANG"))
141 (insert (format " locale-coding-system: %s\n" locale-coding-system
))
142 (insert (format " default-enable-multibyte-characters: %s\n"
143 default-enable-multibyte-characters
))
145 (insert (format "Major mode: %s\n"
146 (buffer-local-value 'mode-name from-buffer
)))
148 (insert "Minor modes in effect:\n")
149 (dolist (mode minor-mode-list
)
150 (and (boundp mode
) (buffer-local-value mode from-buffer
)
151 (insert (format " %s: %s\n" mode
152 (buffer-local-value mode from-buffer
)))))
154 (insert "Recent input:\n")
155 (let ((before-keys (point)))
156 (insert (mapconcat (lambda (key)
157 (if (or (integerp key
)
160 (single-key-description key
)
161 (prin1-to-string key nil
)))
162 (or recent-keys
(recent-keys))
165 (narrow-to-region before-keys
(point))
166 (goto-char before-keys
)
167 (while (progn (move-to-column 50) (not (eobp)))
168 (search-forward " " nil t
)
170 (let ((message-buf (get-buffer "*Messages*")))
173 (end-pos message-end-point
))
174 (with-current-buffer message-buf
177 (setq beg-pos
(point)))
178 (insert "\n\nRecent messages:\n")
179 (insert-buffer-substring message-buf beg-pos end-pos
))))
180 ;; This is so the user has to type something
181 ;; in order to send easily.
182 (use-local-map (nconc (make-sparse-keymap) (current-local-map)))
183 (define-key (current-local-map) "\C-c\C-i" 'report-emacs-bug-info
)
184 (unless report-emacs-bug-no-explanations
185 (with-output-to-temp-buffer "*Bug Help*"
186 (if (eq mail-user-agent
'sendmail-user-agent
)
187 (princ (substitute-command-keys
188 "Type \\[mail-send-and-exit] to send the bug report.\n")))
189 (princ (substitute-command-keys
190 "Type \\[kill-buffer] RET to cancel (don't send it).\n"))
192 (princ (substitute-command-keys
193 "Type \\[report-emacs-bug-info] to visit in Info the Emacs Manual section
194 about when and how to write a bug report,
195 and what information to supply so that the bug can be fixed.
196 Type SPC to scroll through this section and its subsections."))))
197 ;; Make it less likely people will send empty messages.
198 (make-local-variable 'mail-send-hook
)
199 (add-hook 'mail-send-hook
'report-emacs-bug-hook
)
201 (goto-char (point-max))
202 (skip-chars-backward " \t\n")
203 (make-local-variable 'report-emacs-bug-orig-text
)
204 (setq report-emacs-bug-orig-text
(buffer-substring (point-min) (point))))
205 (goto-char user-point
)))
207 (defun report-emacs-bug-info ()
208 "Go to the Info node on reporting Emacs bugs."
213 (Info-goto-node "Bugs"))
215 (defun report-emacs-bug-hook ()
218 (goto-char (point-max))
219 (skip-chars-backward " \t\n")
220 (if (and (= (- (point) (point-min))
221 (length report-emacs-bug-orig-text
))
222 (equal (buffer-substring (point-min) (point))
223 report-emacs-bug-orig-text
))
224 (error "No text entered in bug report")))
226 ;; Check the buffer contents and reject non-English letters.
228 (goto-char (point-min))
229 (skip-chars-forward "\0-\177")
231 (if (or report-emacs-bug-no-confirmation
232 (y-or-n-p "Convert non-ASCII letters to hexadecimal? "))
233 (while (progn (skip-chars-forward "\0-\177")
235 (let ((ch (following-char)))
237 (insert (format "=%02x" ch
)))))))
239 ;; The last warning for novice users.
240 (if (or report-emacs-bug-no-confirmation
242 "Send this bug report to the Emacs maintainers? "))
243 ;; Just send the current mail.
245 (goto-char (point-min))
246 (if (search-forward "To: ")
249 (delete-region pos
(point))))
250 (kill-local-variable 'mail-send-hook
)
251 (with-output-to-temp-buffer "*Bug Help*"
252 (princ (substitute-command-keys "\
253 You invoked the command M-x report-emacs-bug,
254 but you decided not to mail the bug report to the Emacs maintainers.
256 If you want to mail it to someone else instead,
257 please insert the proper e-mail address after \"To: \",
258 and send the mail again using \\[mail-send-and-exit].")))
259 (error "M-x report-emacs-bug was cancelled, please read *Bug Help* buffer"))
263 (if (looking-at report-emacs-bug-text-prompt
)
264 (replace-match "Symptoms:"))))
268 ;;; arch-tag: 248b6523-c3b5-4fec-9a3f-0411fafa7d49
269 ;;; emacsbug.el ends here