doc/manual/support-and-bugs.texinfo

   1 @node Getting Support and Reporting Bugs
   2 @comment  node-name,  next,  previous,  up
   3 @chapter Getting Support and Reporting Bugs
   4
   5 @menu
   6 * Volunteer Support::
   7 * Commercial Support::
   8 * Reporting Bugs::
   9 @end menu
  10
  11 @node Volunteer Support
  12 @comment  node-name,  next,  previous,  up
  13 @section Volunteer Support
  14
  15 Your primary source of SBCL support should probably be the mailing
  16 list @strong{sbcl-help}: in addition to other users SBCL developers
  17 monitor this list and are available for advice. As an anti-spam
  18 measure subscription is required for posting:
  19
  20 @urlline{https://lists.sourceforge.net/lists/listinfo/sbcl-help}
  21
  22 Remember that the people answering your question are volunteers, so
  23 you stand a much better chance of getting a good answer if you ask a
  24 good question.
  25
  26 Before sending mail, check the list archives at either
  27
  28 @urlline{http://sourceforge.net/mailarchive/forum.php?forum_name=sbcl-help}
  29
  30 or
  31
  32 @urlline{http://news.gmane.org/gmane.lisp.steel-bank.general}
  33
  34 to see if your question has been answered already. Checking the bug
  35 database is also worth it @xref{Reporting Bugs}, to see if the issue
  36 is already known.
  37
  38 For general advice on asking good questions, see
  39
  40 @urlline{http://www.catb.org/~esr/faqs/smart-questions.html}.
  41
  42 @node Commercial Support
  43 @comment  node-name,  next,  previous,  up
  44 @section Commercial Support
  45
  46 There is no formal organization developing SBCL, but if you need a
  47 paid support arrangement or custom SBCL development, we maintain the
  48 list of companies and consultants below. Use it to identify service
  49 providers with appropriate skills and interests, and contact them
  50 directly.
  51
  52 The SBCL project cannot verify the accuracy of the information or the
  53 competence of the people listed, and they have provided their own
  54 blurbs below: you must make your own judgement of suitability from the
  55 available information - refer to the links they provide, the CREDITS
  56 file, mailing list archives, CVS commit messages, and so on. Please
  57 feel free to ask for advice on the sbcl-help list.
  58
  59 (At present, no companies or consultants wish to advertise paid support
  60 or custom SBCL development in this manual).
  61
  62 @node Reporting Bugs
  63 @comment  node-name,  next,  previous,  up
  64 @section Reporting Bugs
  65
  66 SBCL uses Launchpad to track bugs. The bug database is available at
  67
  68 @urlline{https://bugs.launchpad.net/sbcl}
  69
  70 Reporting bugs there requires registering at Launchpad. However, bugs
  71 can also be reported on the mailing list @strong{sbcl-bugs}, which is
  72 moderated but does @emph{not} require subscribing.
  73
  74 Simply send email to @email{sbcl-bugs@@lists.sourceforge.net} and the
  75 bug will be checked and added to Launchpad by SBCL maintainers.
  76
  77 @subsection How to Report Bugs Effectively
  78
  79 Please include enough information in a bug report that someone reading
  80 it can reproduce the problem, i.e. don't write
  81
  82 @example
  83 Subject: apparent bug in PRINT-OBJECT (or *PRINT-LENGTH*?)
  84 PRINT-OBJECT doesn't seem to work with *PRINT-LENGTH*. Is this a bug?
  85 @end example
  86
  87 but instead
  88
  89 @example
  90 Subject: apparent bug in PRINT-OBJECT (or *PRINT-LENGTH*?)
  91 In sbcl-1.2.3 running under OpenBSD 4.5 on my Alpha box, when
  92 I compile and load the file
  93    (DEFSTRUCT (FOO (:PRINT-OBJECT (LAMBDA (X Y)
  94                                     (LET ((*PRINT-LENGTH* 4))
  95                                       (PRINT X Y)))))
  96      X Y)
  97 then at the command line type
  98    (MAKE-FOO)
  99 the program loops endlessly instead of printing the object.
 100 @end example
 101
 102 A more in-depth discussion on reporting bugs effectively can be found
 103 at
 104
 105 @urlline{http://www.chiark.greenend.org.uk/~sgtatham/bugs.html}.
 106
 107 @subsection Signal Related Bugs
 108
 109 If you run into a signal related bug, you are getting fatal errors
 110 such as @code{signal N is [un]blocked} or just hangs, and you want to
 111 send a useful bug report then:
 112
 113 @enumerate
 114
 115 @item
 116 @cindex ldb
 117 Compile SBCL with ldb support (feature @code{:sb-ldb}, see
 118 @file{base-target-features.lisp-expr}) and change @code{#define QSHOW_SIGNAL 0} to
 119 @code{#define QSHOW_SIGNAL 1} in @file{src/runtime/runtime.h}.
 120
 121 @item
 122 Isolate a smallish test case, run it.
 123
 124 @item
 125 If it just hangs kill it with sigabrt: @code{kill -ABRT <pidof sbcl>}.
 126
 127 @item
 128 Print the backtrace from ldb by typing @code{ba}.
 129
 130 @item
 131 Attach gdb: @code{gdb -p <pidof sbcl>} and get backtraces for all threads:
 132 @code{thread apply all ba}.
 133
 134 @item
 135 If multiple threads are in play then still in gdb, try to get Lisp
 136 backtrace for all threads: @code{thread apply all call
 137 backtrace_from_fp($ebp, 100)}. Substitute @code{$ebp} with @code{$rbp}
 138 on x86-64. The backtraces will appear in the stdout of the SBCL
 139 process.
 140
 141 @item
 142 Send a report with the backtraces and the output (both stdout and
 143 stderr) produced by SBCL.
 144
 145 @item
 146 Don't forget to include OS and SBCL version.
 147
 148 @item
 149 If available, include information on outcome of the same test with
 150 other versions of SBCL, OS, ...
 151 @end enumerate