Menu
▾
▴
[Sbcl-commits] CVS: sbcl/doc/manual profiling.texinfo,NONE,1.1 streams.texinfo,NONE,1.1 Makefile,1.10,1.11 beyond-ansi.texinfo,1.10,1.11 compiler.texinfo,1.5,1.6 contrib-modules.texinfo,1.3,1.4 debugger.texinfo,1.4,1.5 efficiency.texinfo,1.6,1.7 ffi.texinfo,1.4,1.5 intro.texinfo,1.6,1.7 make-tempfiles.sh,1.5,1.6 package-locks-basic.texinfo,1.2,1.3 package-locks-extended.texinfo,1.3,1.4 sbcl.texinfo,1.10,1.11
|
From: Nikodemus S. <de...@us...> - 2004-08-18 05:50:26
|
Update of /cvsroot/sbcl/sbcl/doc/manual In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv1744/doc/manual Modified Files: Makefile beyond-ansi.texinfo compiler.texinfo contrib-modules.texinfo debugger.texinfo efficiency.texinfo ffi.texinfo intro.texinfo make-tempfiles.sh package-locks-basic.texinfo package-locks-extended.texinfo sbcl.texinfo Added Files: profiling.texinfo streams.texinfo Log Message: 0.8.13.70: MORE DOCUMENTATION * Include documentation, however sparse, for SB-PROFILE, SB-GRAY, and SB-SIMPLE-STREAMS. * Beginnings of restructuring the manual: lift SB-BSD-SOCKETS into a full chapter called "Networking", etc. * An unfortunate consequence of the above is that we cannot autogenerate the contrib-doc list anymore, and the contrib documentation structure is less otrhogonal and has tighter coupling to the general manual structure. Since new contribs appear relatively seldom this is hopefully not a big issue. --- NEW FILE: profiling.texinfo --- @cindex Profiling SBCL includes both an accurate profiler, that can collect statistics on individual functions, and a more ``modern'' statistical profiler. Inlined functions do not appear in the results reported by either. @menu * Accurate Profiler:: * Statistical Profiler:: @end menu @node Accurate Profiler @comment node-name, next, previous, up @section Accurate Profiler @cindex Profiling, accurate The package @code{sb-profile} provides a classic, per-function-call profiler. @include macro-sb-profile-profile.texinfo @include macro-sb-profile-unprofile.texinfo @include fun-sb-profile-report.texinfo @include fun-sb-profile-reset.texinfo @node Statistical Profiler @comment node-name, next, previous, up @section Statistical Profiler @include sb-sprof/sb-sprof.texinfo --- NEW FILE: streams.texinfo --- 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 @dfn{sb-simple-streams} implements a subset of the Franz Allegro simple-streams proposal. @menu * Gray Streams:: * Simple Streams:: @end menu @node Gray Streams @section Gray Streams @include class-sb-gray-fundamental-stream.texinfo @include fun-sb-gray-stream-advance-to-column.texinfo @include fun-sb-gray-stream-clear-input.texinfo @include fun-sb-gray-stream-clear-output.texinfo @include fun-sb-gray-stream-finish-output.texinfo @include fun-sb-gray-stream-force-output.texinfo @include fun-sb-gray-stream-fresh-line.texinfo @include fun-sb-gray-stream-line-column.texinfo @include fun-sb-gray-stream-line-length.texinfo @include fun-sb-gray-stream-listen.texinfo @include fun-sb-gray-stream-peek-char.texinfo @include fun-sb-gray-stream-read-byte.texinfo @include fun-sb-gray-stream-read-char-no-hang.texinfo @include fun-sb-gray-stream-read-char.texinfo @include fun-sb-gray-stream-read-line.texinfo @include fun-sb-gray-stream-read-sequence.texinfo @include fun-sb-gray-stream-start-line-p.texinfo @include fun-sb-gray-stream-terpri.texinfo @include fun-sb-gray-stream-unread-char.texinfo @include fun-sb-gray-stream-write-byte.texinfo @include fun-sb-gray-stream-write-char.texinfo @include fun-sb-gray-stream-write-sequence.texinfo @include fun-sb-gray-stream-write-string.texinfo @node Simple Streams @comment node-name, next, previous, up @section Simple Streams @include sb-simple-streams/sb-simple-streams.texinfo Index: Makefile =================================================================== RCS file: /cvsroot/sbcl/sbcl/doc/manual/Makefile,v retrieving revision 1.10 retrieving revision 1.11 diff -u -d -r1.10 -r1.11 --- Makefile 1 Aug 2004 23:33:06 -0000 1.10 +++ Makefile 17 Aug 2004 17:32:13 -0000 1.11 @@ -1,4 +1,3 @@ - DOCFILES:=$(shell echo *.texinfo) ROOTFILE:=sbcl.texinfo TMPFILES:=sbcl.aux sbcl.cp sbcl.fn sbcl.ky sbcl.log sbcl.pg sbcl.toc sbcl.tp sbcl.vr @@ -13,6 +12,7 @@ # DOCSTRINGDIR has to end with a slash or you lose (it's passed to # Lisp's `pathname' function). DOCSTRINGDIR="docstrings/" +I_FLAGS=-I $(DOCSTRINGDIR) -I ../../contrib/ # List of contrib modules that docstring docs will be created for. # FIXME: should check test-passed and not load them. MODULES=':sb-md5 :sb-rotate-byte :sb-grovel :sb-sprof :sb-bsd-sockets' @@ -47,7 +47,7 @@ html-stamp: variables $(DOCFILES) docstrings @rm -rf $(HTMLDIR) - $(MAKEINFO) -I $(DOCSTRINGDIR) --html $(ROOTFILE) + $(MAKEINFO) $(I_FLAGS) --html $(ROOTFILE) touch html-stamp # Postscript documentation @@ -58,21 +58,21 @@ dvips -o $@ $< $(DVIFILE): variables $(DOCFILES) docstrings - texi2dvi -I $(DOCSTRINGDIR) $(ROOTFILE) + texi2dvi $(I_FLAGS) $(ROOTFILE) # PDF documentation .PHONY: pdf pdf: $(PDFFILE) $(PDFFILE): variables $(DOCFILES) docstrings - texi2pdf -I $(DOCSTRINGDIR) $(ROOTFILE) + texi2pdf $(I_FLAGS) $(ROOTFILE) # info docfiles .PHONY: info info: $(INFOFILE) $(INFOFILE): variables $(DOCFILES) docstrings - $(MAKEINFO) -I $(DOCSTRINGDIR) $(ROOTFILE) + $(MAKEINFO) $(I_FLAGS) $(ROOTFILE) # contrib-modules.texinfo includes contrib-doc-list.texi-temp contrib-modules.texinfo: tempfiles-stamp Index: beyond-ansi.texinfo =================================================================== RCS file: /cvsroot/sbcl/sbcl/doc/manual/beyond-ansi.texinfo,v retrieving revision 1.10 retrieving revision 1.11 diff -u -d -r1.10 -r1.11 --- beyond-ansi.texinfo 16 Aug 2004 18:19:15 -0000 1.10 +++ beyond-ansi.texinfo 17 Aug 2004 17:32:13 -0000 1.11 @@ -1,7 +1,3 @@ -@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 @@ -38,7 +34,7 @@ Declarations are generally treated as assertions. This general principle, and its implications, and the bugs which still keep the compiler from quite satisfying this principle, are discussed in -@ref{The Compiler}. +@ref{Compiler}. SBCL is essentially a compiler-only implementation of Common Lisp. That is, for all but a few special cases, @code{eval} creates a @@ -130,8 +126,8 @@ @comment node-name, next, previous, up @subsection Things Which Might Be In The Next ANSI Standard -SBCL provides extensive support for calling external C code, @ref{The -Foreign Function Interface}. +SBCL provides extensive support for calling external C code, +@ref{Foreign Function Interface}. SBCL provides additional garbage collection functionality not specified by ANSI. Weak pointers allow references to objects to be @@ -417,8 +413,7 @@ facility. For more information, see @ref{macro-common-lisp-trace}. The debugger supports a number of options. Its documentation is -accessed by typing @kbd{help} at the debugger prompt. @xref{The -Debugger}. +accessed by typing @kbd{help} at the debugger prompt. @xref{Debugger}. Documentation for @code{inspect} is accessed by typing @kbd{help} at the @code{inspect} prompt. Index: compiler.texinfo =================================================================== RCS file: /cvsroot/sbcl/sbcl/doc/manual/compiler.texinfo,v retrieving revision 1.5 retrieving revision 1.6 diff -u -d -r1.5 -r1.6 --- compiler.texinfo 17 May 2004 16:17:58 -0000 1.5 +++ compiler.texinfo 17 Aug 2004 17:32:13 -0000 1.6 @@ -1,7 +1,3 @@ -@node The Compiler -@comment node-name, next, previous, up -@chapter The Compiler - 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, Index: contrib-modules.texinfo =================================================================== RCS file: /cvsroot/sbcl/sbcl/doc/manual/contrib-modules.texinfo,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- contrib-modules.texinfo 7 Aug 2004 18:21:05 -0000 1.3 +++ contrib-modules.texinfo 17 Aug 2004 17:32:13 -0000 1.4 @@ -1,11 +1,25 @@ -@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 documentation (or pointers to documentation) for the contributed modules. -@include contrib-doc-list.texi-temp +@menu +* sb-aclrepl:: +* sb-grovel:: +* sb-md5:: +* sb-rotate-byte:: +@end menu + +@page +@include sb-aclrepl/sb-aclrepl.texinfo + +@page +@include sb-grovel/sb-grovel.texinfo + +@page +@include sb-md5/sb-md5.texinfo + +@page +@include sb-rotate-byte/sb-rotate-byte.texinfo + Index: debugger.texinfo =================================================================== RCS file: /cvsroot/sbcl/sbcl/doc/manual/debugger.texinfo,v retrieving revision 1.4 retrieving revision 1.5 diff -u -d -r1.4 -r1.5 --- debugger.texinfo 19 Jun 2004 21:42:49 -0000 1.4 +++ debugger.texinfo 17 Aug 2004 17:32:13 -0000 1.5 @@ -1,6 +1,3 @@ -@node The Debugger -@comment node-name, next, previous, up -@chapter The 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.6 retrieving revision 1.7 diff -u -d -r1.6 -r1.7 --- efficiency.texinfo 16 Apr 2004 14:17:39 -0000 1.6 +++ efficiency.texinfo 17 Aug 2004 17:32:14 -0000 1.7 @@ -1,6 +1,4 @@ -@node Efficiency -@comment node-name, next, previous, up -@chapter Efficiency +@cindex Efficiency FIXME: The material in the CMUCL manual about getting good performance from the compiler should be reviewed, reformatted in Index: ffi.texinfo =================================================================== RCS file: /cvsroot/sbcl/sbcl/doc/manual/ffi.texinfo,v retrieving revision 1.4 retrieving revision 1.5 diff -u -d -r1.4 -r1.5 --- ffi.texinfo 22 Jul 2004 07:46:32 -0000 1.4 +++ ffi.texinfo 17 Aug 2004 17:32:14 -0000 1.5 @@ -1,7 +1,3 @@ -@node The Foreign Function Interface -@comment node-name, next, previous, up -@chapter The 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.6 retrieving revision 1.7 diff -u -d -r1.6 -r1.7 --- intro.texinfo 24 May 2004 14:01:17 -0000 1.6 +++ intro.texinfo 17 Aug 2004 17:32:14 -0000 1.7 @@ -1,7 +1,3 @@ -@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: make-tempfiles.sh =================================================================== RCS file: /cvsroot/sbcl/sbcl/doc/manual/make-tempfiles.sh,v retrieving revision 1.5 retrieving revision 1.6 diff -u -d -r1.5 -r1.6 --- make-tempfiles.sh 4 Jul 2004 15:52:16 -0000 1.5 +++ make-tempfiles.sh 17 Aug 2004 17:32:14 -0000 1.6 @@ -1,7 +1,6 @@ #!/bin/sh # Create Texinfo snippets from the documentation of exported symbols. -# Also create contrib-docs.texi-temp to include documentation in contrib/. # This software is part of the SBCL system. See the README file for # more information. @@ -42,9 +41,6 @@ echo /creating docstring snippets from SBCL=\'$SBCLRUNTIME\' for packages \'$PACKAGES\' echo "(progn (load \"docstrings.lisp\") (dolist (module (quote ($MODULES))) (require module)) (docstrings-to-texinfo \"$DOCSTRINGDIR\" $PACKAGES) (sb-ext:quit))" | $SBCL -echo /creating contrib-docs.texi-temp -echo "(load \"create-contrib-doc-list.lisp\")" | $SBCL - echo /creating package-locks.texi-temp if $SBCL --eval "(let ((plp (find-symbol \"PACKAGE-LOCKED-P\" :sb-ext))) (quit :unix-status (if (and plp (fboundp plp)) 0 1)))"; then Index: package-locks-basic.texinfo =================================================================== RCS file: /cvsroot/sbcl/sbcl/doc/manual/package-locks-basic.texinfo,v retrieving revision 1.2 retrieving revision 1.3 diff -u -d -r1.2 -r1.3 --- package-locks-basic.texinfo 4 Jul 2004 15:03:47 -0000 1.2 +++ package-locks-basic.texinfo 17 Aug 2004 17:32:14 -0000 1.3 @@ -1,7 +1,3 @@ -@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.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- package-locks-extended.texinfo 22 Jul 2004 00:18:40 -0000 1.3 +++ package-locks-extended.texinfo 17 Aug 2004 17:32:14 -0000 1.4 @@ -1,6 +1,4 @@ -@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 locksing support. Index: sbcl.texinfo =================================================================== RCS file: /cvsroot/sbcl/sbcl/doc/manual/sbcl.texinfo,v retrieving revision 1.10 retrieving revision 1.11 diff -u -d -r1.10 -r1.11 --- sbcl.texinfo 29 Jun 2004 08:50:58 -0000 1.10 +++ sbcl.texinfo 17 Aug 2004 17:32:14 -0000 1.11 @@ -56,31 +56,114 @@ @insertcopying @menu -* Introduction:: -* The Compiler:: -* The Debugger:: -* Efficiency:: -* Beyond The ANSI Standard:: -* The Foreign Function Interface:: -* Package Locks:: -* Contributed Modules:: -* Concept Index:: -* Function Index:: -* Variable Index:: -* Type Index:: -* Colophon:: +* Introduction:: +* Compiler:: +* Debugger:: +* Efficiency:: +* Beyond the ANSI Standard:: +* Foreign Function Interface:: +* Extensible Streams:: +* Package Locks:: +* Networking:: +* Profiling:: +* Contributed Modules:: +* Concept Index:: +* Function Index:: +* Variable Index:: +* Type Index:: +* Colophon:: @end menu @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 -@include backmatter.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. + @bye |