From: Nikodemus S. <de...@us...> - 2004-08-17 22:49:23
|
Update of /cvsroot/sbcl/sbcl/doc/manual In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv14243/doc/manual Modified Files: beyond-ansi.texinfo compiler.texinfo contrib-modules.texinfo debugger.texinfo efficiency.texinfo ffi.texinfo intro.texinfo package-locks-basic.texinfo package-locks-extended.texinfo profiling.texinfo sbcl.texinfo streams.texinfo Log Message: 0.8.13.71: CORRECT DOCUMENTATION * Slightly less, but hopefully more representative of reality, documentation for type checking policies. * Generally reorganize the Compiler chapter a bit, moving and renaming some sections -- eg. split "Compiler Errors" --> "Compiler Diagnostics" and "Compiler Errors". * Back out a bogus lifting of chapter @nodes into sbcl.texinfo which leaked in accidentally. * Remove references to INHIBIT-WARNINGS, leaving only a footnote. Index: beyond-ansi.texinfo =================================================================== RCS file: /cvsroot/sbcl/sbcl/doc/manual/beyond-ansi.texinfo,v retrieving revision 1.11 retrieving revision 1.12 diff -u -d -r1.11 -r1.12 --- beyond-ansi.texinfo 17 Aug 2004 17:32:13 -0000 1.11 +++ beyond-ansi.texinfo 17 Aug 2004 18:34:29 -0000 1.12 @@ -1,3 +1,7 @@ +@node Beyond the ANSI Standard +@comment node-name, next, previous, up +@chapter Beyond the ANSI Standard + SBCL is mostly an implementation of the ANSI standard for Common Lisp. However, there's some important behavior which extends or clarifies the standard, and various behavior which outright Index: compiler.texinfo =================================================================== RCS file: /cvsroot/sbcl/sbcl/doc/manual/compiler.texinfo,v retrieving revision 1.6 retrieving revision 1.7 diff -u -d -r1.6 -r1.7 --- compiler.texinfo 17 Aug 2004 17:32:13 -0000 1.6 +++ compiler.texinfo 17 Aug 2004 18:34:29 -0000 1.7 @@ -1,27 +1,177 @@ -This chapter will discuss most compiler issues other than -efficiency, including compiler error messages, the SBCL compiler's -unusual approach to type safety in the presence of type declarations, -the effects of various compiler optimization policies, and the way -that inlining and open coding may cause optimized code to differ from -a naive translation. Efficiency issues are sufficiently varied and +@node Compiler +@comment node-name, next, previous, up +@chapter Compiler + +This chapter will discuss most compiler issues other than efficiency, [...980 lines suppressed...] +; DO step variable is not a symbol: (ATOM CURRENT) +@end example + + +@node Read Errors +@comment node-name, next, previous, up +@subsection Read Errors +@cindex Read errors, compiler + +SBCL's compiler does not attempt to recover from read errors when +reading a source file, but instead just reports the offending +character position and gives up on the entire source file. @node Open Coding and Inline Expansion @comment node-name, next, previous, up @@ -1048,4 +1117,3 @@ may be transformed into a different function call (as in the last example) or compiled as @emph{static call}. Static function call uses a more efficient calling convention that forbids redefinition. - Index: contrib-modules.texinfo =================================================================== RCS file: /cvsroot/sbcl/sbcl/doc/manual/contrib-modules.texinfo,v retrieving revision 1.4 retrieving revision 1.5 diff -u -d -r1.4 -r1.5 --- contrib-modules.texinfo 17 Aug 2004 17:32:13 -0000 1.4 +++ contrib-modules.texinfo 17 Aug 2004 18:34:29 -0000 1.5 @@ -1,3 +1,7 @@ +@node Contributed Modules +@comment node-name, next, previous, up +@chapter Contributed Modules + SBCL comes with a number of modules that are not part of the core system. These are loaded via @code{(require :@var{modulename})} (@pxref{Customization Hooks for Users}). This section contains Index: debugger.texinfo =================================================================== RCS file: /cvsroot/sbcl/sbcl/doc/manual/debugger.texinfo,v retrieving revision 1.5 retrieving revision 1.6 diff -u -d -r1.5 -r1.6 --- debugger.texinfo 17 Aug 2004 17:32:13 -0000 1.5 +++ debugger.texinfo 17 Aug 2004 18:34:29 -0000 1.6 @@ -1,3 +1,6 @@ +@node Debugger +@comment node-name, next, previous, up +@chapter Debugger @cindex Debugger The SBCL debugger (as the CMUCL debugger it was derived from) has very Index: efficiency.texinfo =================================================================== RCS file: /cvsroot/sbcl/sbcl/doc/manual/efficiency.texinfo,v retrieving revision 1.7 retrieving revision 1.8 diff -u -d -r1.7 -r1.8 --- efficiency.texinfo 17 Aug 2004 17:32:14 -0000 1.7 +++ efficiency.texinfo 17 Aug 2004 18:34:29 -0000 1.8 @@ -1,3 +1,6 @@ +@node Efficiency +@comment node-name, next, previous, up +@chapter Efficiency @cindex Efficiency FIXME: The material in the CMUCL manual about getting good Index: ffi.texinfo =================================================================== RCS file: /cvsroot/sbcl/sbcl/doc/manual/ffi.texinfo,v retrieving revision 1.5 retrieving revision 1.6 diff -u -d -r1.5 -r1.6 --- ffi.texinfo 17 Aug 2004 17:32:14 -0000 1.5 +++ ffi.texinfo 17 Aug 2004 18:34:29 -0000 1.6 @@ -1,3 +1,7 @@ +@node Foreign Function Interface +@comment node-name, next, previous, up +@chapter Foreign Function Interface + This chapter describes SBCL's interface to C programs and libraries (and, since C interfaces are a sort of @emph{ingua franca} of the Unix world, to other programs and libraries in Index: intro.texinfo =================================================================== RCS file: /cvsroot/sbcl/sbcl/doc/manual/intro.texinfo,v retrieving revision 1.7 retrieving revision 1.8 diff -u -d -r1.7 -r1.8 --- intro.texinfo 17 Aug 2004 17:32:14 -0000 1.7 +++ intro.texinfo 17 Aug 2004 18:34:29 -0000 1.8 @@ -1,3 +1,7 @@ +@node Introduction +@comment node-name, next, previous, up +@chapter Introduction + SBCL is a mostly-conforming implementation of the ANSI Common Lisp standard. This manual focuses on behavior which is specific to SBCL, not on behavior which is common to all implementations of ANSI Common Index: package-locks-basic.texinfo =================================================================== RCS file: /cvsroot/sbcl/sbcl/doc/manual/package-locks-basic.texinfo,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- package-locks-basic.texinfo 17 Aug 2004 17:32:14 -0000 1.3 +++ package-locks-basic.texinfo 17 Aug 2004 18:34:29 -0000 1.4 @@ -1,3 +1,7 @@ +@node Package Locks +@comment node-name, next, previous, up +@chapter Package Locks + SBCL can be built with support for package locks to protect against unintentional modifications of packages. The full documentation for package locks is only built if package locks are enabled in the image Index: package-locks-extended.texinfo =================================================================== RCS file: /cvsroot/sbcl/sbcl/doc/manual/package-locks-extended.texinfo,v retrieving revision 1.4 retrieving revision 1.5 diff -u -d -r1.4 -r1.5 --- package-locks-extended.texinfo 17 Aug 2004 17:32:14 -0000 1.4 +++ package-locks-extended.texinfo 17 Aug 2004 18:34:29 -0000 1.5 @@ -1,3 +1,6 @@ +@node Package Locks +@comment node-name, next, previous, up +@chapter Package Locks @cindex Packages, locked None of the following sections apply to SBCL built without package @@ -9,19 +12,19 @@ renamed. @menu -* Package Lock Concepts:: -* Package Lock Dictionary:: +* Package Lock Concepts:: +* Package Lock Dictionary:: @end menu @node Package Lock Concepts @section Package Lock Concepts @menu -* Package Lock Overview:: +* Package Lock Overview:: * Implementation Packages:: -* Package Lock Violations:: -* Package Locks in Compiled Code:: -* Operations Violating Package Locks:: +* Package Lock Violations:: +* Package Locks in Compiled Code:: +* Operations Violating Package Locks:: @end menu @node Package Lock Overview Index: profiling.texinfo =================================================================== RCS file: /cvsroot/sbcl/sbcl/doc/manual/profiling.texinfo,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- profiling.texinfo 17 Aug 2004 17:32:14 -0000 1.1 +++ profiling.texinfo 17 Aug 2004 18:34:29 -0000 1.2 @@ -1,3 +1,6 @@ +@node Profiling +@comment node-name, next, previous, up +@chapter Profiling @cindex Profiling SBCL includes both an accurate profiler, that can collect statistics Index: sbcl.texinfo =================================================================== RCS file: /cvsroot/sbcl/sbcl/doc/manual/sbcl.texinfo,v retrieving revision 1.11 retrieving revision 1.12 diff -u -d -r1.11 -r1.12 --- sbcl.texinfo 17 Aug 2004 17:32:14 -0000 1.11 +++ sbcl.texinfo 17 Aug 2004 18:34:29 -0000 1.12 @@ -76,94 +76,17 @@ @end ifnottex -@node Introduction -@comment node-name, next, previous, up -@chapter Introduction @include intro.texinfo - -@node Compiler -@comment node-name, next, previous, up -@chapter Compiler @include compiler.texinfo - -@node Debugger -@comment node-name, next, previous, up -@chapter Debugger @include debugger.texinfo - -@node Efficiency -@comment node-name, next, previous, up -@chapter Efficiency @include efficiency.texinfo - -@node Beyond the ANSI Standard -@comment node-name, next, previous, up -@chapter Beyond the ANSI Standard @include beyond-ansi.texinfo - -@node Foreign Function Interface -@comment node-name, next, previous, up -@chapter Foreign Function Interface @include ffi.texinfo - -@node Extensible Streams -@comment node-name, next, previous, up -@chapter Extensible Streams @include streams.texinfo - -@node Package Locks -@comment node-name, next, previous, up -@chapter Package Locks @include package-locks.texi-temp - -@node Networking -@comment node-name, next, previous, up -@chapter Networking @include sb-bsd-sockets/sb-bsd-sockets.texinfo - -@node Profiling -@comment node-name, next, previous, up -@chapter Profiling @include profiling.texinfo - -@node Contributed Modules -@comment node-name, next, previous, up -@chapter Contributed Modules @include contrib-modules.texinfo - -@node Concept Index -@comment node-name, next, previous, up -@appendix Concept Index -@printindex cp - -@node Function Index -@comment node-name, next, previous, up -@appendix Function Index -@printindex fn - -@node Variable Index -@comment node-name, next, previous, up -@appendix Variable Index -@printindex vr - -@node Type Index -@comment node-name, next, previous, up -@appendix Type Index -@printindex tp - -@node Colophon -@comment node-name, next, previous, up -@unnumbered Colophon - -This manual is maintained in Texinfo, and automatically translated -into other forms (e.g. HTML or pdf). If you're @emph{reading} this -manual in one of these non-Texinfo translated forms, that's fine, but -if you want to @emph{modify} this manual, you are strongly advised to -seek out a Texinfo version and modify that instead of modifying a -translated version. Even better might be to seek out @emph{the} -Texinfo version (maintained at the time of this writing as part of the -SBCL project at @uref{http://sbcl.sourceforge.net/}) and submit a -patch. - +@include backmatter.texinfo @bye Index: streams.texinfo =================================================================== RCS file: /cvsroot/sbcl/sbcl/doc/manual/streams.texinfo,v retrieving revision 1.1 retrieving revision 1.2 diff -u -d -r1.1 -r1.2 --- streams.texinfo 17 Aug 2004 17:32:14 -0000 1.1 +++ streams.texinfo 17 Aug 2004 18:34:29 -0000 1.2 @@ -1,3 +1,7 @@ +@node Extensible Streams +@comment node-name, next, previous, up +@chapter Extensible Streams + SBCL supports @dfn{Gray streams}, user-overloadable CLOS classes whose instances can be used as Lisp streams (e.g. passed as the first argument to @code{format}). Additionally, the bundled contrib module @@ -5,8 +9,8 @@ simple-streams proposal. @menu -* Gray Streams:: -* Simple Streams:: +* Gray Streams:: +* Simple Streams:: @end menu @node Gray Streams |