Skip to content

Commit

Permalink
0.8.14.20: Documentation madness, yet again
Browse files Browse the repository at this point in the history
            * Merge a partial rewrite of the docstring extractor,
               capable of handling a few more cases and providing
               nicer xref-names: @Xref{Macro common-lisp:trace}
               instead of @Xref{macro-common-lisp-trace}.
            * Reformat a few docstrings for nicer display.
            * Add documentation for LOAD-SHARED-OBJECT to the manual.
            * Move SAVE-LISP-AND-DIE to "Starting and Stopping"
               chapter. Say bye-bye to "Interface to Low-level
               Implementation."
            * Extract the version number for the manual from
               the SBCL the docstrings are pulled from, not
               version.lisp-expr.
  • Loading branch information
nikodemus committed Sep 14, 2004
1 parent 4d5d7a4 commit 53f4147
Show file tree
Hide file tree
Showing 13 changed files with 752 additions and 499 deletions.
12 changes: 4 additions & 8 deletions doc/manual/Makefile
Expand Up @@ -6,7 +6,6 @@ TMPFILES:=$(foreach target,asdf sbcl,$(foreach type,$(TMPTYPES),$(target).$(type
PSFILES=sbcl.ps asdf.ps
PDFFILES=sbcl.pdf asdf.pdf
INFOFILES=sbcl.info asdf.info
VARSFILE=variables.template
HTMLDIRS=$(basename $(SBCLTEXI)) $(basename $(ASDFTEXI))
# Place where generated documentation ends up. The value of
# DOCSTRINGDIR has to end with a slash or you lose (it's passed to
Expand Down Expand Up @@ -41,14 +40,11 @@ asdf.texinfo:
rm -f asdf.texinfo
ln -s ../../contrib/asdf/asdf.texinfo

variables: ${VARSFILE}
./extract-values.sh < ${VARSFILE} >variables.texinfo

# html documentation; output in $(HTMLDIRS)
.PHONY: html
html: html-stamp

html-stamp: variables $(DOCFILES) docstrings
html-stamp: $(DOCFILES) docstrings
@rm -rf $(HTMLDIRS)
$(MAKEINFO) $(I_FLAGS) --html $(SBCLTEXI)
$(MAKEINFO) --html $(ASDFTEXI)
Expand All @@ -62,21 +58,21 @@ ps: $(PSFILES)
dvips -o $@ $<

# DVI generation
%.dvi: %.texinfo variables $(DOCFILES) docstrings
%.dvi: %.texinfo $(DOCFILES) docstrings
texi2dvi $(I_FLAGS) $<

# PDF documentation
.PHONY: pdf
pdf: $(PDFFILES)

%.pdf: %.texinfo variables $(DOCFILES) docstrings
%.pdf: %.texinfo $(DOCFILES) docstrings
texi2pdf $(I_FLAGS) $<

# info docfiles
.PHONY: info
info: $(INFOFILES)

%.info: %.texinfo variables $(DOCFILES) docstrings
%.info: %.texinfo $(DOCFILES) docstrings
$(MAKEINFO) $(I_FLAGS) $<

# Texinfo docstring snippets
Expand Down
24 changes: 1 addition & 23 deletions doc/manual/beyond-ansi.texinfo
Expand Up @@ -11,7 +11,6 @@ it still has quite a few. @xref{Contributed Modules}.
* Support For Unix::
* Customization Hooks for Users::
* Tools To Help Developers::
* Interface To Low-Level SBCL Implementation::
* Stale Extensions::
* Efficiency Hacks::
@end menu
Expand Down Expand Up @@ -98,35 +97,14 @@ mechanisms as follows:
@section Tools To Help Developers

SBCL provides a profiler and other extensions to the ANSI @code{trace}
facility. For more information, see @ref{macro-common-lisp-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. @xref{Debugger}.

Documentation for @code{inspect} is accessed by typing @kbd{help} at
the @code{inspect} prompt.

@node Interface To Low-Level SBCL Implementation
@comment node-name, next, previous, up
@section Interface To Low-Level SBCL Implementation

SBCL has the ability to save its state as a file for later
execution. This functionality is important for its bootstrapping
process, and is also provided as an extension to the user.

Note that foreign libraries loaded via @code{load-shared-object} don't
survive this process on all platforms; a core should not be saved in
this case. Platforms where this is supported as of SBCL 0.8.14.5 are
x86/Linux, x86/FreeBSD and sparc/SunOS.

@emph{FIXME: what should be done for foreign libraries?}

@emph{FIXME: document load-shared-object somewhere - it's in
ffi.texinfo?}

@include fun-sb-ext-save-lisp-and-die.texinfo


@node Stale Extensions
@comment node-name, next, previous, up
@section Stale Extensions
Expand Down
2 changes: 1 addition & 1 deletion doc/manual/compiler.texinfo
Expand Up @@ -769,7 +769,7 @@ Policy Control}.
Ordinarily, when the @code{speed} quality is high, the compiler emits
notes to notify the programmer about its inability to apply various
optimizations. For selective muffling of these notes @xref{Controlling
Verbosity}
Verbosity}.

The value of @code{space} mostly influences the compiler's decision
whether to inline operations, which tend to increase the size of
Expand Down
4 changes: 2 additions & 2 deletions doc/manual/debugger.texinfo
Expand Up @@ -921,7 +921,7 @@ returning a value from the current stack frame.

If @code{debug} is also at least 2, then the code is @emph{partially
steppable}. If @code{debug} is 3, the code is @emph{fully steppable}.
@xref{Single Stepping} for details.
@xref{Single Stepping}, for details.

@end table

Expand Down Expand Up @@ -1186,7 +1186,7 @@ function entry or exit.

SBCL includes an instrumentation based single-stepper for compiled
code, that can be invoked via the @code{step} macro, or from within
the debugger. @xref{Debugger Policy Control} for details on enabling
the debugger. @xref{Debugger Policy Control}, for details on enabling
stepping for compiled code.

Compiled code can be unsteppable, partially steppable, or fully steppable.
Expand Down

0 comments on commit 53f4147

Please sign in to comment.