Commit [0f2750] Maximize Restore History

1.0.28.75: documentation work related to move to Launchpad

* Delete SUPPORT and minimize BUGS.

The information that used to be there is now the first chapter of
the manual: "Getting Support and Reporting Bugs", Maybe it belongs
elsewhere, but IMO it should be as prominent as we can make it - so
the first chapter for now.

Refer to Lauchpad and sbcl-bugs in "Reporting Bugs".

Remove Dan B. from support providers for now, given that
metacircles.com is currently domain-parked.

Nikodemus Siivola Nikodemus Siivola 2009-06-03

changed doc/manual/intro.texinfo
changed doc/manual/sbcl.texinfo
changed BUGS
changed NEWS
changed version.lisp-expr
copied SUPPORT -> doc/manual/support-and-bugs.texinfo
doc/manual/intro.texinfo Diff Switch to side-by-side view
Loading...
doc/manual/sbcl.texinfo Diff Switch to side-by-side view
Loading...
BUGS Diff Switch to side-by-side view
Loading...
NEWS Diff Switch to side-by-side view
Loading...
version.lisp-expr Diff Switch to side-by-side view
Loading...
SUPPORT to doc/manual/support-and-bugs.texinfo
--- a/SUPPORT
+++ b/doc/manual/support-and-bugs.texinfo
@@ -1,65 +1,162 @@
-* Mailing lists
+@node Getting Support and Reporting Bugs
+@comment  node-name,  next,  previous,  up
+@chapter Getting Support and Reporting Bugs
 
-Your first recourse for support should probably be to the mailing list
-  sbcl-help@lists.sourceforge.net
+@menu
+* Volunteer Support::           
+* Commercial Support::          
+* Reporting Bugs::              
+@end menu
+
+@node Volunteer Support
+@comment  node-name,  next,  previous,  up
+@section Volunteer Support
+
+Your primary source of SBCL support should probably be the mailing
+list @strong{sbcl-help}: in addition to other users SBCL developers
+monitor this list and are available for advice. As an anti-spam
+measure subcription is required for posting:
+
+@urlline{https://lists.sourceforge.net/lists/listinfo/sbcl-help}
 
 Remember that the people answering your question are volunteers, so
 you stand a much better chance of getting a good answer if you ask a
-good question: before sending mail, check
- 
-- the list archives, to check if your question has been answered already
-   http://sourceforge.net/mailarchive/forum.php?forum_id=4134   
- 
-    or (same list, different archive)
- 
-   http://news.gmane.org/gmane.lisp.steel-bank.general  
-  
-- the BUGS file, to see if we know about it.  Note that some of the 
-  bugs in this file are old and it might be useful to have fresh reports, 
-  in particular if you have new information that might help debugging
+good question.
 
-- advice on how to report bugs and ask questions that people want to
-  answer
+Before sending mail, check the list archives at either
 
-    http://www.chiark.greenend.org.uk/~sgtatham/bugs.html
-    http://www.catb.org/~esr/faqs/smart-questions.html
+@urlline{http://sourceforge.net/mailarchive/forum.php?forum_name=sbcl-help}
 
-* Consultants
+or
+
+@urlline{http://news.gmane.org/gmane.lisp.steel-bank.general}
+
+to see if your question has been answered already. Checking the bug
+database is also worth it @xref{Reporting Bugs}, to see if the issue
+is already known.
+
+For general advice on asking good questions, see
+
+@urlline{http://www.catb.org/~esr/faqs/smart-questions.html}.
+
+@node Commercial Support
+@comment  node-name,  next,  previous,  up
+@section Commercial Support
 
 There is no formal organization developing SBCL, but if you need a
-paid support arrangement or custom SBCL development, we maintain a
-list of consultants in this file.  Use it to identify consultants with
-appropriate skills and interests, and contact them directly.
+paid support arrangement or custom SBCL development, we maintain the
+list of companies and consultants below. Use it to identify service
+providers with appropriate skills and interests, and contact them
+directly.
 
-The compilers of this file have made no attempt to verify the accuracy
-of the information or the competence of the people listed: you must
-make your own judgement of suitability from the available information
-- refer to the links they provide, the CREDITS file, mailing list
-archives, CVS commit messages, and so on.  Please feel free to ask for
-advice on the sbcl-help list.
+The SBCL project cannot verify the accuracy of the information or the
+competence of the people listed, and they have provided their own
+blurbs below: you must make your own judgement of suitability from the
+available information - refer to the links they provide, the CREDITS
+file, mailing list archives, CVS commit messages, and so on. Please
+feel free to ask for advice on the sbcl-help list.
 
-Name:      Daniel Barlow
-Email:     dan@metacircles.com
-PGP:       1024D/75908913 : FC7 3143 7340 DECA D17A  357D 1C32 B966 7590 8913
-Web:       http://web.metacircles.com/sbcl
-Expertise: Lowlevel issues (threads, GC, runtime support).  Ports to new systems.  Network/web applications.  ASDF, asdf-install, contrib issues.
-Offerings: Custom programming.   Email-based support (per-incident).  
+@table @strong
+@item Christophe Rhodes
+is a long-time SBCL developer, available for custom programming.
 
-Name:      Christophe Rhodes
-Email:     csr21@cam.ac.uk
-PGP:       1024D/52D68DF2 : B36B 91C5 1835 DB9B FBAB  735B 84C5 E278 52D6 8DF2
-Expertise: Ports to new systems, optimizations of current platforms.  Library bug fixes or enhancements.
-Offerings: Custom programming.
+Email: @email{csr21@@cam.ac.uk}
 
-Name:      Nikodemus Siivola / Steel Bank Studio Ltd
-Email:     nikodemus@sb-studio.net
-PGP:       9B58 2337 94FF 912E 2658  C891 6D2A 6420 028F 7EC5
-Web:       http://www.sb-studio.net
-Expertise: General SBCL support and development.
-Offerings: Support and custom programming.
+@item Steel Bank Studio Ltd
+provides commercial SBCL support and custom development, is run by
+SBCL developer @emph{Nikodemus Siivola}, and has another SBCL
+developer @emph{Richard Kreuter} as an affiliated consultant.
 
-[ If you provide SBCL-related services, please add your details to
-this file keeping alphabetical order by surname, following the
-template used by existing entries.  Patches are welcome from those
-with no CVS commit access.  We don't maintain a PGP keyring, so please
-ensure your key can be found on the public servers ]
+Website: @url{http://sb-studio.net/}
+
+Email: @email{info@@sb-studio.net}
+@end table
+
+@node Reporting Bugs
+@comment  node-name,  next,  previous,  up
+@section Reporting Bugs
+
+SBCL uses Launchpad to track bugs. The bug database is available at
+
+@urlline{https://bugs.launchpad.net/sbcl}
+
+Reporting bugs there requires registering at Launchpad. However, bugs
+can also be reported on the mailing list @strong{sbcl-bugs}, which is
+moderated but does @emph{not} require subscribing.
+
+Simply send email to @email{sbcl-bugs@@lists.sourceforge.net} and the
+bug will be checked and added to Launchpad by SBCL maintainers.
+
+@subsection How to Report Bugs Effectively
+
+Please include enough information in a bug report that someone reading
+it can reproduce the problem, i.e. don't write
+
+@example
+Subject: apparent bug in PRINT-OBJECT (or *PRINT-LENGTH*?)
+PRINT-OBJECT doesn't seem to work with *PRINT-LENGTH*. Is this a bug?
+@end example
+
+but instead
+
+@example
+Subject: apparent bug in PRINT-OBJECT (or *PRINT-LENGTH*?)
+In sbcl-1.2.3 running under OpenBSD 4.5 on my Alpha box, when
+I compile and load the file
+   (DEFSTRUCT (FOO (:PRINT-OBJECT (LAMBDA (X Y)
+                                    (LET ((*PRINT-LENGTH* 4))
+                                      (PRINT X Y)))))
+     X Y)
+then at the command line type
+   (MAKE-FOO)
+the program loops endlessly instead of printing the object.
+@end example
+
+A more in-depth discussion on reporting bugs effectively can be found
+at
+
+@urlline{http://www.chiark.greenend.org.uk/~sgtatham/bugs.html}.
+
+@subsection Signal Related Bugs
+
+If you run into a signal related bug, you are getting fatal errors
+such as @code{signal N is [un]blocked} or just hangs, and you want to
+send a useful bug report then:
+
+@enumerate
+
+@item
+Compile sbcl with ldb support (feature @code{:sb-ldb}, see
+@file{base-target-features.lisp-expr}) and change @code{#define QSHOW_SIGNAL 0} to
+@code{#define QSHOW_SIGNAL 1} in @file{src/runtime/runtime.h}.
+
+@item
+Isolate a smallish test case, run it.
+
+@item
+If it just hangs kill it with sigabrt: @code{kill -ABRT <pidof sbcl>}.
+
+@item
+Print the backtrace from ldb by typing @code{ba}.
+
+@item
+Attach gdb: @code{gdb -p <pidof sbcl>} and get backtraces for all threads:
+@code{thread apply all ba}.
+
+@item
+If multiple threads are in play then still in gdb, try to get Lisp
+backtrace for all threads: @code{thread apply all
+call_backtrace_from_fp($ebp, 100)}. Substitute $ebp with $rbp on
+x86-64. The backtraces will appear in the stdout of the SBCL process.
+
+@item
+Send a report with the backtraces and the output (both stdout and
+stderr) produced by SBCL.
+
+@item
+Don't forget to include OS and SBCL version.
+
+@item
+If available include, information on outcome of the same test with
+other versions of SBCL, OS, ...
+@end enumerate