1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
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
156
157
158
159
160
161
162
163
164
165
166
167
168
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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
|
;;; emacsbug.el --- command to report Emacs bugs to appropriate mailing list
;; Copyright (C) 1985, 1994, 1997, 1998, 2000, 2001, 2002, 2003,
;; 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
;; Author: K. Shane Hartman
;; Maintainer: FSF
;; Keywords: maint mail
;; 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
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) 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
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; `M-x report-emacs-bug' starts an email note to the Emacs maintainers
;; 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.
;;; Code:
(require 'sendmail)
(defgroup emacsbug nil
"Sending Emacs bug reports."
:group 'maint
:group 'mail)
(defcustom report-emacs-bug-address "bug-gnu-emacs@gnu.org"
"Address of mailing list for GNU Emacs bugs."
:group 'emacsbug
:type 'string)
(defcustom report-emacs-bug-pretest-address "emacs-pretest-bug@gnu.org"
"Address of mailing list for GNU Emacs pretest bugs."
:group 'emacsbug
:type 'string)
(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)
;; User options end here.
(defvar report-emacs-bug-orig-text nil
"The automatically-created initial text of bug report.")
(declare-function x-server-vendor "xfns.c" (&optional terminal))
(declare-function x-server-version "xfns.c" (&optional terminal))
;;;###autoload
(defun report-emacs-bug (topic &optional recent-keys)
"Report a bug in GNU Emacs.
Prompts for bug subject. Leaves you in a mail buffer."
;; 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: "))))
;; The syntax `version;' is preferred to `[version]' because the
;; latter could be mistakenly stripped by mailing software.
(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))
(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)
(setq message-end-point
(with-current-buffer (get-buffer-create "*Messages*")
(point-max-marker)))
(compose-mail reporting-address
topic)
;; The rest of this does not execute
;; if the user was asked to confirm and said no.
(rfc822-goto-eoh)
(forward-line 1)
(let ((signature (buffer-substring (point) (point-max))))
(delete-region (point) (point-max))
(insert signature)
(backward-char (length signature)))
(unless report-emacs-bug-no-explanations
;; Insert warnings for novice users.
(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 ")
(let ((pos (point)))
(insert "English")
(put-text-property pos (point) 'face 'highlight))
(insert " if possible, because the Emacs maintainers
usually do not have translators to read other languages for them.\n\n")
(insert (format "Your bug report will be posted to the %s mailing list"
reporting-address))
(if pretest-p
(insert ".\n\n")
(insert ",\nand to the gnu.emacs.bug news group.\n\n")))
(insert "Please describe exactly what actions triggered the bug\n"
"and the precise symptoms of the bug:\n\n")
(add-text-properties (point) (save-excursion (mail-text) (point))
prompt-properties)
(setq user-point (point))
(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")))
(add-text-properties (1+ user-point) (point) prompt-properties)
(insert "\n\nIn " (emacs-version) "\n")
(if (fboundp 'x-server-vendor)
(condition-case nil
;; This is used not only for X11 but also W32 and others.
(insert "Windowing system distributor `" (x-server-vendor)
"', version "
(mapconcat 'number-to-string (x-server-version) ".") "\n")
(error t)))
(if (and system-configuration-options
(not (equal system-configuration-options "")))
(insert "configured using `configure "
system-configuration-options "'\n\n"))
(insert "Important settings:\n")
(mapc
'(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" "XMODIFIERS"))
(insert (format " locale-coding-system: %s\n" locale-coding-system))
(insert (format " default-enable-multibyte-characters: %s\n"
default-enable-multibyte-characters))
(insert "\n")
(insert (format "Major mode: %s\n"
(format-mode-line
(buffer-local-value 'mode-name from-buffer)
nil nil from-buffer)))
(insert "\n")
(insert "Minor modes in effect:\n")
(dolist (mode minor-mode-list)
(and (boundp mode) (buffer-local-value mode from-buffer)
(insert (format " %s: %s\n" mode
(buffer-local-value mode from-buffer)))))
(insert "\n")
(insert "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)
(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
about when and how to write a bug report,
and what information to supply so that the bug can be fixed.
Type SPC to scroll through this section and its subsections."))))
;; 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)))
(defun report-emacs-bug-info ()
"Go to the Info node on reporting Emacs bugs."
(interactive)
(info "(emacs)Bugs"))
(defun report-emacs-bug-hook ()
(save-excursion
(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")))
;; Check the buffer contents and reject non-English letters.
(save-excursion
(goto-char (point-min))
(skip-chars-forward "\0-\177")
(if (not (eobp))
(if (or report-emacs-bug-no-confirmation
(y-or-n-p "Convert non-ASCII letters to hexadecimal? "))
(while (progn (skip-chars-forward "\0-\177")
(not (eobp)))
(let ((ch (following-char)))
(delete-char 1)
(insert (format "=%02x" ch)))))))
;; The last warning for novice users.
(if (or report-emacs-bug-no-confirmation
(yes-or-no-p
"Send this bug report to the Emacs maintainers? "))
;; 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 "\
You invoked the command M-x report-emacs-bug,
but you decided not to mail the bug report to the Emacs maintainers.
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"))
;; Unclutter
(mail-text)
(let ((pos (1- (point))))
(while (setq pos (text-property-any pos (point-max)
'field 'emacsbug-prompt))
(delete-region pos (field-end (1+ pos)))))))
(provide 'emacsbug)
;; arch-tag: 248b6523-c3b5-4fec-9a3f-0411fafa7d49
;;; emacsbug.el ends here
|
