emacsbug.el 4.69 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.

Karl Heuer's avatar
Karl Heuer committed
3
;; Copyright (C) 1985, 1994 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
Eric S. Raymond's avatar
Eric S. Raymond committed
7
;; Keywords: maint
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 23 24 25
;; 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; see the file COPYING.  If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.

26 27 28 29 30
;;; 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
31
;;; Code:
Joseph Arceneaux's avatar
Joseph Arceneaux committed
32 33 34 35 36

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

37 38
(require 'sendmail)

Joseph Arceneaux's avatar
Joseph Arceneaux committed
39
(defvar bug-gnu-emacs "bug-gnu-emacs@prep.ai.mit.edu"
40
  "Address of site maintaining mailing list for GNU Emacs bugs.")
Joseph Arceneaux's avatar
Joseph Arceneaux committed
41

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

Jim Blandy's avatar
Jim Blandy committed
45
;;;###autoload
Joseph Arceneaux's avatar
Joseph Arceneaux committed
46
(defun report-emacs-bug (topic)
Jim Blandy's avatar
Jim Blandy committed
47
  "Report a bug in GNU Emacs.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
48 49
Prompts for bug subject.  Leaves you in a mail buffer."
  (interactive "sBug Subject: ")
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
  (if (mail nil bug-gnu-emacs topic)
      (let (user-point)
	;; The rest of this does not execute
	;; if the user was asked to confirm and said no.
	(goto-char (point-min))
	(re-search-forward (concat "^" (regexp-quote mail-header-separator) "\n"))
	(insert "In " (emacs-version) "\n")
	(if (and system-configuration-options
		 (not (equal system-configuration-options "")))
	    (insert "configured using `configure "
		    system-configuration-options "'\n"))
	(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 (function (lambda (key)
					 (if (or (integerp key)
						 (symbolp key)
						 (listp key))
					     (single-key-description key)
					   (prin1-to-string key nil))))
			     (recent-keys)
			     " "))
	  (goto-char before-keys)
	  (while (progn (move-to-column 50) (not (eobp)))
	    (search-forward " " nil t)
	    (insert "\n")))
80 81 82 83 84 85 86 87 88 89 90 91 92
	(let ((message-buf (get-buffer "*Messages*")))
	  (if message-buf
	      (progn
		(insert "\n\nRecent messages:\n")
		(insert-buffer-substring message-buf
					 (save-excursion
					   (set-buffer message-buf)
					   (goto-char (point-max))
					   (forward-line -10)
					   (point))
					 (save-excursion
					   (set-buffer message-buf)
					   (point-max))))))
93 94 95 96 97 98 99 100 101 102 103 104
	;; 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)
	(with-output-to-temp-buffer "*Bug Help*"
	  (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
105 106 107
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.")))
108 109 110 111 112 113 114 115 116
	;; 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))))
117

118 119 120 121 122 123 124 125
(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"))

126 127 128 129 130 131 132 133 134
(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))
	(error "No text entered in bug report"))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
135

136 137
(provide 'emacsbug)

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