]> code.delx.au - gnu-emacs/blobdiff - lisp/mail/emacsbug.el
Reword header comment to prevent copyright.el wanting to update years.
[gnu-emacs] / lisp / mail / emacsbug.el
index 14a0a8d4ef1a1e4fa7d8634fcbd4fbd33e86ae71..73e61a4668dc6d50ea05965df9064d37b6d855d4 100644 (file)
@@ -1,19 +1,18 @@
 ;;; 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 Free Software Foundation, Inc.
+;; Copyright (C) 1985, 1994, 1997, 1998, 2000, 2001, 2002, 2003, 2004,
+;;   2005, 2006, 2007, 2008, 2009  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
+;; 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, or (at your option)
-;; any later version.
+;; 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
 ;; 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, Inc., 51 Franklin Street, Fifth Floor,
-;; Boston, MA 02110-1301, USA.
+;; 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.  Here's how it's done...
+;; 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:
 
-;; >> 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.
-
 (require 'sendmail)
 
 (defgroup emacsbug nil
   :group 'mail)
 
 (defcustom report-emacs-bug-address "bug-gnu-emacs@gnu.org"
-  "*Address of mailing list for GNU Emacs bugs."
+  "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."
+  "Address of mailing list for GNU Emacs pretest bugs."
   :group 'emacsbug
   :type 'string)
 
-(defvar report-emacs-bug-orig-text nil
-  "The automatically-created initial text of bug report.")
-
 (defcustom report-emacs-bug-no-confirmation nil
-  "*If non-nil, suppress the confirmations asked for the sake of novice users."
+  "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."
+  "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.
@@ -128,7 +129,8 @@ usually do not have translators to read other languages for them.\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")
+           "and the precise symptoms of the bug.  If you can, give\n"
+           "a recipe starting from `emacs -Q':\n\n")
     (add-text-properties (point) (save-excursion (mail-text) (point))
                          prompt-properties)
 
@@ -141,8 +143,8 @@ usually do not have translators to read other languages for them.\n\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")))
+         (insert "For information about debugging Emacs, please read the file\n"
+                 debug-file ".\n")))
     (add-text-properties (1+ user-point) (point) prompt-properties)
 
     (insert "\n\nIn " (emacs-version) "\n")
@@ -164,11 +166,13 @@ usually do not have translators to read other languages for them.\n\n")
      '("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 (format "  default enable-multibyte-characters: %s\n"
+                   (default-value 'enable-multibyte-characters)))
     (insert "\n")
     (insert (format "Major mode: %s\n"
-                   (buffer-local-value 'mode-name from-buffer)))
+                   (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)
@@ -202,23 +206,37 @@ usually do not have translators to read other languages for them.\n\n")
              (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.
+    ;; After Recent messages, to avoid the messages produced by
+    ;; list-load-path-shadows.
+    (unless (looking-back "\n")
+      (insert "\n"))
+    (insert "\n")
+    (insert "Load-path shadows:\n")
+    (message "Checking for load-path shadows...")
+    (let ((shadows (list-load-path-shadows t)))
+      (message "Checking for load-path shadows...done")
+      (insert (if (zerop (length shadows))
+                  "None found.\n"
+                shadows)))
+    (insert (format "\nFeatures:\n%s\n" features))
+    (fill-region (line-beginning-position 0) (point))
+    ;; 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*"
+       (princ "While in the mail buffer:\n\n")
        (if (eq mail-user-agent 'sendmail-user-agent)
            (princ (substitute-command-keys
-                   "Type \\[mail-send-and-exit] to send the bug report.\n")))
+                   "  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"))
+               "  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."))))
+               "  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 you should include to help fix the bug.")))
+      (shrink-window-if-larger-than-buffer (get-buffer-window "*Bug Help*")))
     ;; Make it less likely people will send empty messages.
     (make-local-variable 'mail-send-hook)
     (add-hook 'mail-send-hook 'report-emacs-bug-hook)
@@ -229,16 +247,10 @@ Type SPC to scroll through this section and its subsections."))))
       (setq report-emacs-bug-orig-text (buffer-substring (point-min) (point))))
     (goto-char user-point)))
 
-(declare-function Info-menu "info" (menu-item &optional fork))
-(declare-function Info-goto-node "info" (nodename &optional fork))
-
 (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"))
+  (info "(emacs)Bugs"))
 
 (defun report-emacs-bug-hook ()
   (save-excursion