emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* Improving bug reporting documentation
@ 2011-11-07 23:06 Suvayu Ali
  2011-12-12 16:34 ` [Accepted] " Bastien Guerry
  2011-12-12 16:47 ` Bastien
  0 siblings, 2 replies; 3+ messages in thread
From: Suvayu Ali @ 2011-11-07 23:06 UTC (permalink / raw)
  To: Org mode mailing list

[-- Attachment #1: Type: text/plain, Size: 497 bytes --]

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.

[-- Attachment #2: 0001-Improve-Feedback-section-in-docs.patch --]
[-- Type: text/plain, Size: 1997 bytes --]

From cf8935331d2f57ef5c954fad2f5e3f179d902081 Mon Sep 17 00:00:00 2001
From: Suvayu Ali <fatkasuvayu+linux@gmail.com>
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


^ permalink raw reply related	[flat|nested] 3+ messages in thread
end of thread, other threads:[~2011-12-12 16:46 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2011-11-07 23:06 Improving bug reporting documentation Suvayu Ali
2011-12-12 16:34 ` [Accepted] " Bastien Guerry
2011-12-12 16:47 ` Bastien

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).