From mboxrd@z Thu Jan 1 00:00:00 1970 From: Suvayu Ali Subject: Improving bug reporting documentation Date: Tue, 8 Nov 2011 00:06:20 +0100 Message-ID: <20111108000620.6fd433b6@kuru.homelinux.net> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="MP_/A3CzoKzNyNEKWpd0CpGZ1jg" Return-path: Received: from eggs.gnu.org ([140.186.70.92]:48042) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1RNYGn-0001KA-Lp for emacs-orgmode@gnu.org; Mon, 07 Nov 2011 18:06:26 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1RNYGm-000777-AZ for emacs-orgmode@gnu.org; Mon, 07 Nov 2011 18:06:25 -0500 Received: from mail-fx0-f41.google.com ([209.85.161.41]:62012) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1RNYGl-00076K-RH for emacs-orgmode@gnu.org; Mon, 07 Nov 2011 18:06:24 -0500 Received: by faaf16 with SMTP id f16so7215579faa.0 for ; Mon, 07 Nov 2011 15:06:22 -0800 (PST) List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org To: Org mode mailing list --MP_/A3CzoKzNyNEKWpd0CpGZ1jg Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Content-Disposition: inline Hi Bastien and others, Lately I have been seeing a lot of bug reports sent using the org-submit-bug-report. The reporter usually reports the bug from a session they have been using with their full blown customisations. And often they are requested to reproduce the bug with emacs -Q. So I thought it would be easier if the manual mentioned this little detail. A patch is attached. Hope this helps. PS: I marked the patch as TINY CHANGE. -- Suvayu Open source is the future. It sets us free. --MP_/A3CzoKzNyNEKWpd0CpGZ1jg Content-Type: text/plain Content-Transfer-Encoding: 7bit Content-Disposition: attachment; filename=0001-Improve-Feedback-section-in-docs.patch >From cf8935331d2f57ef5c954fad2f5e3f179d902081 Mon Sep 17 00:00:00 2001 From: Suvayu Ali Date: Mon, 7 Nov 2011 23:54:05 +0100 Subject: [PATCH] Improve Feedback section in docs * org.texi (Feedback): Add instruction o how to start emacs with minimal customisations TINY CHANGE --- doc/org.texi | 30 ++++++++++++++++++++++++++++++ 1 files changed, 30 insertions(+), 0 deletions(-) diff --git a/doc/org.texi b/doc/org.texi index 4a547d0..1bc9a98 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -987,6 +987,36 @@ @section Feedback that you only need to add your description. If you re not sending the Email from within Emacs, please copy and paste the content into your Email program. +Sometimes you might face a problem due to an error in your Emacs or Org-mode +setup. Before reporting a bug, it is very helpful to start Emacs with minimal +customisations and reproduce the problem. Doing so often helps you determine +if the problem is with your customisation or with Org-mode itself. You can +start a typical minimal session with a command like the example below. + +@example +$ emacs -Q -l /path/to/minimal-org.el +@end example + +However if you are using Org-mode as distributed with Emacs, a minimal setup +is not necessary. In that case it is sufficient to start Emacs as @code{emacs +-Q}. The @code{minimal-org.el} setup file can have contents as shown below. + +@example +;;; Minimal setup to load latest `org-mode' + +;; activate debugging +(setq debug-on-error t + debug-on-signal nil + debug-on-quit nil) + +;; add latest org-mode to load path +(add-to-list 'load-path (expand-file-name "/path/to/org-mode/lisp")) +(add-to-list 'load-path (expand-file-name "/path/to/org-mode/contrib/lisp")) + +;; activate org +(require 'org-install) +@end example + If an error occurs, a backtrace can be very useful (see below on how to create one). Often a small example file helps, along with clear information about: -- 1.7.7 --MP_/A3CzoKzNyNEKWpd0CpGZ1jg--