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.
This commit is contained in:
Nikodemus Siivola 2009-06-03 09:09:52 +00:00
parent 5b5853f5f5
commit 0f27506665
7 changed files with 205 additions and 1750 deletions

1661
BUGS

File diff suppressed because it is too large Load diff

5
NEWS
View file

@ -1,4 +1,9 @@
;;;; -*- coding: utf-8; fill-column: 78 -*- ;;;; -*- coding: utf-8; fill-column: 78 -*-
* IMPORTANT: bug database has moved from the BUGS file to Launchpad
https://bugs.launchpad.net/sbcl
Bugs can be reported directly there, or by sending email to
sbcl-bugs@lists.sourceforge.net
(no subscription required.)
* minor incompatible change: under weak type checking policy integer * minor incompatible change: under weak type checking policy integer
types are weakened less aggressively. types are weakened less aggressively.
* minor incompatible change: SAVE-LISP-AND-DIE :TOPLEVEL function is now * minor incompatible change: SAVE-LISP-AND-DIE :TOPLEVEL function is now

65
SUPPORT
View file

@ -1,65 +0,0 @@
* Mailing lists
Your first recourse for support should probably be to the mailing list
sbcl-help@lists.sourceforge.net
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
- advice on how to report bugs and ask questions that people want to
answer
http://www.chiark.greenend.org.uk/~sgtatham/bugs.html
http://www.catb.org/~esr/faqs/smart-questions.html
* Consultants
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.
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.
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).
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.
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.
[ 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 ]

View file

@ -24,16 +24,8 @@ Lisp.
@section ANSI Conformance @section ANSI Conformance
Essentially every type of non-conformance is considered a bug. (The Essentially every type of non-conformance is considered a bug. (The
exceptions involve internal inconsistencies in the standard.) In SBCL exceptions involve internal inconsistencies in the standard.)
the master record of known bugs is in the @file{BUGS} file in the @xref{Reporting Bugs}.
distribution.
The recommended way to report bugs is through the @cite{sbcl-help} or
@cite{sbcl-devel} mailing lists. For mailing list addresses,
see @ref{SBCL Homepage}; note that as a spam-reduction measure you
must subscribe before you can post.
@node Extensions @node Extensions
@comment node-name, next, previous, up @comment node-name, next, previous, up
@ -348,8 +340,8 @@ sb-ext:save-lisp-and-die}.
@menu @menu
* SBCL Homepage:: * SBCL Homepage::
* Additional Distributed Documentation::
* Online Documentation:: * Online Documentation::
* Additional Documentation Files::
* Internals Documentation:: * Internals Documentation::
@end menu @end menu
@ -363,9 +355,23 @@ archives of these mailing lists. Subscribing to the mailing lists
@cite{sbcl-help} and @cite{sbcl-announce} is recommended: both are @cite{sbcl-help} and @cite{sbcl-announce} is recommended: both are
fairly low-volume, and help you keep abrest with SBCL development. fairly low-volume, and help you keep abrest with SBCL development.
@node Additional Distributed Documentation @node Online Documentation
@comment node-name, next, previous, up @comment node-name, next, previous, up
@subsection Additional Distributed Documentation @subsection Online Documentation
Documentation for non-ANSI extensions for various commands is
available online from the SBCL executable itself. The extensions
for functions which have their own command prompts (e.g. the debugger,
and @code{inspect}) are documented in text available by typing
@command{help} at their command prompts. The extensions for functions
which don't have their own command prompt (such as @code{trace}) are
described in their documentation strings, unless your SBCL was
compiled with an option not to include documentation strings, in which
case the documentation strings are only readable in the source code.
@node Additional Documentation Files
@comment node-name, next, previous, up
@subsection Additional Documentation Files
Besides this user manual both SBCL source and binary distributions Besides this user manual both SBCL source and binary distributions
include some other SBCL-specific documentation files, which should be include some other SBCL-specific documentation files, which should be
@ -374,9 +380,6 @@ installed along with this manual in on your system, eg. in
@table @file @table @file
@item BUGS
Lists known bugs in the distribution.
@item COPYING @item COPYING
Licence and copyright summary. Licence and copyright summary.
@ -391,25 +394,8 @@ information.
@item NEWS @item NEWS
Summarizes changes between various SBCL versions. Summarizes changes between various SBCL versions.
@item SUPPORT
Lists SBCL developers available for-pay development of SBCL.
@end table @end table
@node Online Documentation
@comment node-name, next, previous, up
@subsection Online Documentation
Documentation for non-ANSI extensions for various commands is
available online from the SBCL executable itself. The extensions
for functions which have their own command prompts (e.g. the debugger,
and @code{inspect}) are documented in text available by typing
@command{help} at their command prompts. The extensions for functions
which don't have their own command prompt (such as @code{trace}) are
described in their documentation strings, unless your SBCL was
compiled with an option not to include documentation strings, in which
case the documentation strings are only readable in the source code.
@node Internals Documentation @node Internals Documentation
@comment node-name, next, previous, up @comment node-name, next, previous, up
@subsection Internals Documentation @subsection Internals Documentation

View file

@ -44,6 +44,10 @@ provided with absolutely no warranty. See the @file{COPYING} and
@contents @contents
@macro urlline{text}
@w{ } @w{ } @url{\text\}
@end macro
@ifnottex @ifnottex
@c We use @&key, etc to escape & from TeX in lambda lists -- @c We use @&key, etc to escape & from TeX in lambda lists --
@ -68,7 +72,8 @@ provided with absolutely no warranty. See the @file{COPYING} and
@insertcopying @insertcopying
@menu @menu
* Introduction:: * Getting Support and Reporting Bugs::
* Introduction::
* Starting and Stopping:: * Starting and Stopping::
* Compiler:: * Compiler::
* Debugger:: * Debugger::
@ -92,6 +97,7 @@ provided with absolutely no warranty. See the @file{COPYING} and
@end ifnottex @end ifnottex
@include support-and-bugs.texinfo
@include intro.texinfo @include intro.texinfo
@include start-stop.texinfo @include start-stop.texinfo
@include compiler.texinfo @include compiler.texinfo

View file

@ -0,0 +1,162 @@
@node Getting Support and Reporting Bugs
@comment node-name, next, previous, up
@chapter Getting Support and Reporting Bugs
@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 at either
@urlline{http://sourceforge.net/mailarchive/forum.php?forum_name=sbcl-help}
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 the
list of companies and consultants below. Use it to identify service
providers with appropriate skills and interests, and contact them
directly.
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.
@table @strong
@item Christophe Rhodes
is a long-time SBCL developer, available for custom programming.
Email: @email{csr21@@cam.ac.uk}
@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.
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

View file

@ -17,4 +17,4 @@
;;; checkins which aren't released. (And occasionally for internal ;;; checkins which aren't released. (And occasionally for internal
;;; versions, especially for internal versions off the main CVS ;;; versions, especially for internal versions off the main CVS
;;; branch, it gets hairier, e.g. "0.pre7.14.flaky4.13".) ;;; branch, it gets hairier, e.g. "0.pre7.14.flaky4.13".)
"1.0.28.74" "1.0.28.75"