diff options
author | suvayu ali <fatkasuvayu+linux@gmail.com> | 2011-11-08 04:06:20 +0000 |
---|---|---|
committer | Bastien Guerry <bzg@altern.org> | 2011-12-12 17:34:06 +0100 |
commit | c9ac829394df3ab8e0fbdd970cb3e90814465fec (patch) | |
tree | 1e6f32342b213cbfed4c0f31640740ef789471cd | |
parent | 3ddcdb25b7dcb8d1e950f2c909d4a4e7404e54f9 (diff) | |
download | org-mode-c9ac829394df3ab8e0fbdd970cb3e90814465fec.tar.gz |
Improving bug reporting documentation
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.
-rw-r--r-- | doc/org.texi | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/org.texi b/doc/org.texi index ca60921..baad111 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -1002,6 +1002,36 @@ version information of Emacs (@kbd{M-x emacs-version @key{RET}}) and Org 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: |