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 subcription 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 @table @strong
  60 @item Steel Bank Studio Ltd
  61 provides commercial SBCL support and custom development, is run by
  62 SBCL developer @emph{Nikodemus Siivola}, and has another SBCL
  63 developer @emph{Richard Kreuter} as an affiliated consultant.
  64
  65 Website: @url{http://sb-studio.net/}
  66
  67 Email: @email{info@@sb-studio.net}
  68
  69 @end table
  70
  71 @node Reporting Bugs
  72 @comment  node-name,  next,  previous,  up
  73 @section Reporting Bugs
  74
  75 SBCL uses Launchpad to track bugs. The bug database is available at
  76
  77 @urlline{https://bugs.launchpad.net/sbcl}
  78
  79 Reporting bugs there requires registering at Launchpad. However, bugs
  80 can also be reported on the mailing list @strong{sbcl-bugs}, which is
  81 moderated but does @emph{not} require subscribing.
  82
  83 Simply send email to @email{sbcl-bugs@@lists.sourceforge.net} and the
  84 bug will be checked and added to Launchpad by SBCL maintainers.
  85
  86 @subsection How to Report Bugs Effectively
  87
  88 Please include enough information in a bug report that someone reading
  89 it can reproduce the problem, i.e. don't write
  90
  91 @example
  92 Subject: apparent bug in PRINT-OBJECT (or *PRINT-LENGTH*?)
  93 PRINT-OBJECT doesn't seem to work with *PRINT-LENGTH*. Is this a bug?
  94 @end example
  95
  96 but instead
  97
  98 @example
  99 Subject: apparent bug in PRINT-OBJECT (or *PRINT-LENGTH*?)
 100 In sbcl-1.2.3 running under OpenBSD 4.5 on my Alpha box, when
 101 I compile and load the file
 102    (DEFSTRUCT (FOO (:PRINT-OBJECT (LAMBDA (X Y)
 103                                     (LET ((*PRINT-LENGTH* 4))
 104                                       (PRINT X Y)))))
 105      X Y)
 106 then at the command line type
 107    (MAKE-FOO)
 108 the program loops endlessly instead of printing the object.
 109 @end example
 110
 111 A more in-depth discussion on reporting bugs effectively can be found
 112 at
 113
 114 @urlline{http://www.chiark.greenend.org.uk/~sgtatham/bugs.html}.
 115
 116 @subsection Signal Related Bugs
 117
 118 If you run into a signal related bug, you are getting fatal errors
 119 such as @code{signal N is [un]blocked} or just hangs, and you want to
 120 send a useful bug report then:
 121
 122 @enumerate
 123
 124 @item
 125 @cindex ldb
 126 Compile sbcl with ldb support (feature @code{:sb-ldb}, see
 127 @file{base-target-features.lisp-expr}) and change @code{#define QSHOW_SIGNAL 0} to
 128 @code{#define QSHOW_SIGNAL 1} in @file{src/runtime/runtime.h}.
 129
 130 @item
 131 Isolate a smallish test case, run it.
 132
 133 @item
 134 If it just hangs kill it with sigabrt: @code{kill -ABRT <pidof sbcl>}.
 135
 136 @item
 137 Print the backtrace from ldb by typing @code{ba}.
 138
 139 @item
 140 Attach gdb: @code{gdb -p <pidof sbcl>} and get backtraces for all threads:
 141 @code{thread apply all ba}.
 142
 143 @item
 144 If multiple threads are in play then still in gdb, try to get Lisp
 145 backtrace for all threads: @code{thread apply all call
 146 backtrace_from_fp($ebp, 100)}. Substitute @code{$ebp} with @code{$rbp}
 147 on x86-64. The backtraces will appear in the stdout of the SBCL
 148 process.
 149
 150 @item
 151 Send a report with the backtraces and the output (both stdout and
 152 stderr) produced by SBCL.
 153
 154 @item
 155 Don't forget to include OS and SBCL version.
 156
 157 @item
 158 If available, include information on outcome of the same test with
 159 other versions of SBCL, OS, ...
 160 @end enumerate