0.8.9.32:

* Documentation changes:

    - Document trace and require

    - Add variable index

    - Remove explicit links from @node lines, since makeinfo figures
      this out anyway and they would make automagic contrib/
      documentation inclusion harder.

    - add file TEXINFO-HINTS

* Documentation infractructure changes:

    - document functions etc. with package prefix; index without
      package prefix too (makeinfo seems to index the name with prefix
      without being asked, so we just lay back and enjoy it)

    - Move list-of-packages-to-extract-docstrings-from to Makefile

    - Escape Texinfo special characters in documentation bodies as well.

doc/manual/Makefile

@@ -8,9 +8,12 @@ PDFFILE=sbcl.pdf
 DVIFILE=sbcl.dvi
 INFOFILE=sbcl.info
 HTMLDIR=$(basename $(ROOTFILE))
-# The value of DOCSTRINGDIR has to end with a slash or you lose (it's
-# passed to Lisp's `pathname' function).
+# Place where generated documentation ends up. The value of
+# DOCSTRINGDIR has to end with a slash or you lose (it's passed to
+# Lisp's `pathname' function).
 DOCSTRINGDIR="docstrings/"
+# List of package names that documentation will be created for.
+PACKAGES=":COMMON-LISP :SB-ALIEN :SB-DEBUG :SB-EXT :SB-GRAY :SB-MOP :SB-PROFILE :SB-THREAD"
 
 
 ifeq ($(MAKEINFO),)
@@ -78,7 +81,7 @@ docstrings-stamp:
 
 .PHONY: clean
 clean: 
-	rm -f *~ *.bak *.orig \#*\# .\#* texput.log
+	rm -f *~ *.bak *.orig \#*\# .\#* texput.log *.fasl
 	rm -rf $(HTMLDIR) $(DOCSTRINGDIR)
 	rm -f $(PSFILE) $(PDFFILE) $(DVIFILE) html-stamp docstrings-stamp
 	rm -f $(TMPFILES)

doc/manual/TEXINFO-HINTS

@@ -0,0 +1,14 @@
+-*- text -*-
+
+Some hints for editing the manual files.  Feel free to add anything
+that will save the next person some time.  Thanks!
+
+
+- There's no need for Next, Prev, etc. pointers in @node lines:
+  makeinfo will deduce these automatically when the line after @node
+  contains a sectioning command like @section, @subsection.  Hence,
+  texinfo-multiple-files-update should not be used either.
+
+- Don't create or update Menus by hand; use C-c C-u C-a
+  (texinfo-all-menus-update) instead.  (Doesn't work in sbcl.texinfo,
+  but this file is only changed when an entire chapter is added.)

doc/manual/backmatter.texinfo

@@ -1,16 +1,22 @@
-@node Function Index, Concept Index, The Foreign Function Interface, Top
+@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 Concept Index, Colophon, Function Index, Top
+@node Variable Index
 @comment  node-name,  next,  previous,  up
-@appendix Concept Index
-
-@printindex cp
+@appendix Variable Index
+     
+@printindex vr
 
-@node Colophon,  , Concept Index, Top
+@node Colophon
 @comment  node-name,  next,  previous,  up
 @unnumbered Colophon
 

doc/manual/beyond-ansi.texinfo

@@ -1,4 +1,4 @@
-@node  Beyond The ANSI Standard, The Foreign Function Interface, Efficiency, Top
+@node  Beyond The ANSI Standard
 @comment  node-name,  next,  previous,  up
 @chapter Beyond The ANSI Standard
 
@@ -14,7 +14,7 @@ violates the standard.
 * Extensions::                  
 @end menu
 
-@node Non-Conformance With The ANSI Standard, Idiosyncrasies, Beyond The ANSI Standard, Beyond The ANSI Standard
+@node Non-Conformance With The ANSI Standard
 @comment  node-name,  next,  previous,  up
 @section Non-Conformance With The ANSI Standard
 
@@ -27,7 +27,7 @@ through the sbcl-help or sbcl-devel mailings lists.  For mailing list
 addresses, @ref{More SBCL Information}.
 
 
-@node Idiosyncrasies, Extensions, Non-Conformance With The ANSI Standard, Beyond The ANSI Standard
+@node Idiosyncrasies
 @comment  node-name,  next,  previous,  up
 @section Idiosyncrasies
 
@@ -107,7 +107,7 @@ wrapped in @code{eval-when}, and ideally should be suppressed in that
 case, but still isn't as of SBCL 0.7.6.)
 
 
-@node  Extensions,  , Idiosyncrasies, Beyond The ANSI Standard
+@node  Extensions
 @comment  node-name,  next,  previous,  up
 @section Extensions
 
@@ -126,7 +126,7 @@ it still has quite a few.
 * Efficiency Hacks::            
 @end menu
 
-@node  Things Which Might Be In The Next ANSI Standard, Threading, Extensions, Extensions
+@node  Things Which Might Be In The Next ANSI Standard
 @comment  node-name,  next,  previous,  up
 @subsection Things Which Might Be In The Next ANSI Standard
 
@@ -171,7 +171,7 @@ requested order from a user-supplied primary method.
 @end itemize
 
 
-@node  Threading, Support For Unix, Things Which Might Be In The Next ANSI Standard, Extensions
+@node  Threading
 @comment  node-name,  next,  previous,  up
 @subsection Threading (a.k.a Multiprocessing)
 
@@ -286,7 +286,7 @@ Lisp session makes a new POSIX session, so that pressing
 this has been found to be embarrassing.
 
 
-@node  Support For Unix, Customization Hooks for Users, Threading, Extensions
+@node  Support For Unix
 @comment  node-name,  next,  previous,  up
 @subsection Support For Unix
 
@@ -304,44 +304,39 @@ file on input is also supported.
 
 @include fun-sb-ext-quit.texinfo
 
-@node  Customization Hooks for Users, Tools To Help Developers, Support For Unix, Extensions
+@node  Customization Hooks for Users
 @comment  node-name,  next,  previous,  up
 @subsection Customization Hooks for Users
 
-The behaviour of @code{require} when called with only one argument is
-implementation-defined.  In SBCL it calls functions on the
-user-settable list @code{sb-ext:*module-provider-functions*} - see the
-@code{require} documentation string for details.
-
 The toplevel repl prompt may be customized, and the function
 that reads user input may be replaced completely.
 @c <!-- FIXME but I don't currently remember how -->
 
+The behaviour of @code{require} when called with only one argument is
+implementation-defined.  In SBCL, @code{require} behaves in the
+following way:
+
+@include fun-common-lisp-require.texinfo
+
+@include var-sb-ext-star-module-provider-functions-star.texinfo
+
 
-@node  Tools To Help Developers, Interface To Low-Level SBCL Implementation, Customization Hooks for Users, Extensions
+@node  Tools To Help Developers
 @comment  node-name,  next,  previous,  up
 @subsection Tools To Help Developers
 
-SBCL provides a profiler and other extensions to the ANSI
-@code{trace} facility. See the online function documentation for
-@code{trace} for more information.
+SBCL provides a profiler and other extensions to the ANSI @code{trace}
+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.
-@c <!-- FIXME:
-@c      A true debugger section in the manual would be good. Start
-@c      with CMU CL's debugger section, but remember:
-@c      * no QUIT command (TOPLEVEL restart instead)
-@c      * no GO command (CONTINUE restart instead)
-@c      * Limitations of the x86 port of the debugger should be 
-@c      documented or fixed where possible.
-@c      * Discuss TRACE and its unification with PROFILE. -->
+accessed by typing @kbd{help} at the debugger prompt.  @xref{The
+Debugger}.
 
 Documentation for @code{inspect} is accessed by typing @kbd{help} at
 the @code{inspect} prompt.
 
 
-@node  Interface To Low-Level SBCL Implementation, Efficiency Hacks, Tools To Help Developers, Extensions
+@node  Interface To Low-Level SBCL Implementation
 @comment  node-name,  next,  previous,  up
 @subsection Interface To Low-Level SBCL Implementation
 
@@ -373,7 +368,7 @@ list.
 @end quotation
 
 
-@node  Efficiency Hacks,  , Interface To Low-Level SBCL Implementation, Extensions
+@node  Efficiency Hacks
 @comment  node-name,  next,  previous,  up
 @subsection Efficiency Hacks
 

doc/manual/compiler.texinfo

@@ -1,4 +1,4 @@
-@node  The Compiler, The Debugger, Introduction, Top
+@node  The Compiler
 @comment  node-name,  next,  previous,  up
 @chapter The Compiler
 
@@ -17,7 +17,7 @@ separate that they have their own chapter, @ref{Efficiency}.
 * Open Coding and Inline Expansion::  
 @end menu
 
-@node  Error Messages, Handling of Types, The Compiler, The Compiler
+@node  Error Messages
 @comment  node-name,  next,  previous,  up
 @section Error Messages
 @cindex Error messages, Compiler
@@ -50,7 +50,7 @@ The main problem with this program is that it is trying to add
 * Read Errors::                 
 @end menu
 
-@node  The Parts of the Error Message, The Original and Actual Source, Error Messages, Error Messages
+@node  The Parts of the Error Message
 @comment  node-name,  next,  previous,  up
 @subsection The Parts of the Error Message
 
@@ -189,7 +189,7 @@ intervene between the original source and the actual source, then the
 processing path will also be omitted.
 
 
-@node  The Original and Actual Source, Error Severity, The Parts of the Error Message, Error Messages
+@node  The Original and Actual Source
 @comment  node-name,  next,  previous,  up
 @subsection The Original and Actual Source
 
@@ -289,7 +289,7 @@ was applied. The innermost actual source form was the symbol
 explanation, so the compiler backed out one level.
 
 
-@node  Error Severity, Errors During Macroexpansion, The Original and Actual Source, Error Messages
+@node  Error Severity
 @comment  node-name,  next,  previous,  up
 @subsection Error Severity
 @cindex Severity of compiler errors
@@ -307,7 +307,7 @@ condition classes, typically hints about how efficiency might be
 improved.
 
 
-@node  Errors During Macroexpansion, Read Errors, Error Severity, Error Messages
+@node  Errors During Macroexpansion
 @comment  node-name,  next,  previous,  up
 @subsection Errors During Macroexpansion
 @cindex Macroexpansion, errors during
@@ -336,7 +336,7 @@ DO step variable is not a symbol: (ATOM CURRENT)
 @end example
 
 
-@node  Read Errors,  , Errors During Macroexpansion, Error Messages
+@node  Read Errors
 @comment  node-name,  next,  previous,  up
 @subsection Read Errors
 @cindex Read errors, compiler
@@ -394,7 +394,7 @@ offending character position and gives up on the entire source file.
 @c      _ -->
 
 
-@node  Handling of Types, Compiler Policy, Error Messages, The Compiler
+@node  Handling of Types
 @comment  node-name,  next,  previous,  up
 @section The Compiler's Handling of Types
 
@@ -434,7 +434,7 @@ types.
 @end menu
 
 
-@node  Type Errors at Compile Time, Precise Type Checking, Handling of Types, Handling of Types
+@node  Type Errors at Compile Time
 @comment  node-name,  next,  previous,  up
 @subsection Type Errors at Compile Time
 @cindex Compile time type errors
@@ -491,7 +491,7 @@ can be used in a local declaration to inhibit type warnings in a code
 fragment that has spurious warnings.
 
 
-@node  Precise Type Checking, Weakened Type Checking, Type Errors at Compile Time, Handling of Types
+@node  Precise Type Checking
 @comment  node-name,  next,  previous,  up
 @subsection Precise Type Checking
 @cindex Precise type checking
@@ -539,7 +539,7 @@ precisely as possible. This often involves the use of @code{or},
 @code{member}, and other list-style type specifiers.
 
 
-@node Weakened Type Checking, Getting Existing Programs to Run, Precise Type Checking, Handling of Types
+@node Weakened Type Checking
 @comment  node-name,  next,  previous,  up
 @subsection Weakened Type Checking
 @cindex Weakened type checking
@@ -558,7 +558,7 @@ option believe any or all type declarations with either partial or
 nonexistent runtime checking.
 
 
-@node  Getting Existing Programs to Run, Implementation Limitations, Weakened Type Checking, Handling of Types
+@node  Getting Existing Programs to Run
 @comment  node-name,  next,  previous,  up
 @subsection Getting Existing Programs to Run
 @cindex Existing programs, to run
@@ -704,7 +704,7 @@ variable in the loop body.
 @c <!-- FIXME: <xref>ND-variables, once we crib the text from the 
 @c      CMU CL manual. -->
 
-@node  Implementation Limitations,  , Getting Existing Programs to Run, Handling of Types
+@node  Implementation Limitations
 @comment  node-name,  next,  previous,  up
 @subsection Implementation Limitations
 
@@ -740,7 +740,7 @@ These are important bugs, but are not necessarily easy to fix, so they
 may, alas, remain in the system for a while.
 
 
-@node Compiler Policy, Open Coding and Inline Expansion, Handling of Types, The Compiler
+@node Compiler Policy
 @comment  node-name,  next,  previous,  up
 @section Compiler Policy
 
@@ -942,7 +942,7 @@ is to slow the program by causing cache misses or swapping.
 @c      _-->
 
 
-@node  Open Coding and Inline Expansion,  , Compiler Policy, The Compiler
+@node  Open Coding and Inline Expansion
 @comment  node-name,  next,  previous,  up
 @section Open Coding and Inline Expansion
 @cindex Open-coding