From mboxrd@z Thu Jan 1 00:00:00 1970 From: Bastien Guerry Subject: [Accepted] Improving bug reporting documentation Date: Mon, 12 Dec 2011 17:34:14 +0100 (CET) Message-ID: <20111212163414.2622313E90@myhost.localdomain> References: <20111108000620.6fd433b6@kuru.homelinux.net> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Return-path: Received: from eggs.gnu.org ([140.186.70.92]:37702) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Ra8oZ-0005Qs-Dj for emacs-orgmode@gnu.org; Mon, 12 Dec 2011 11:33:23 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Ra8oU-0007l3-RN for emacs-orgmode@gnu.org; Mon, 12 Dec 2011 11:33:19 -0500 Received: from mail-lpp01m010-f52.google.com ([209.85.215.52]:40835) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Ra8oU-0007km-Ks for emacs-orgmode@gnu.org; Mon, 12 Dec 2011 11:33:14 -0500 Received: by lahj13 with SMTP id j13so272156lah.39 for ; Mon, 12 Dec 2011 08:33:13 -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: emacs-orgmode@gnu.org Patch 1033 (http://patchwork.newartisans.com/patch/1033/) is now "Accepted". Maintainer comment: none This relates to the following submission: http://mid.gmane.org/%3C20111108000620.6fd433b6%40kuru.homelinux.net%3E Here is the original message containing the patch: > Content-Type: text/plain; charset="utf-8" > MIME-Version: 1.0 > Content-Transfer-Encoding: 7bit > Subject: [O] Improving bug reporting documentation > Date: Tue, 08 Nov 2011 04:06:20 -0000 > From: suvayu ali > X-Patchwork-Id: 1033 > Message-Id: <20111108000620.6fd433b6@kuru.homelinux.net> > To: Org mode mailing list > > 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. > > > 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: >