From 91fa18ee11c81e3d0857d61b78ddc52e8e963d7b Mon Sep 17 00:00:00 2001 From: Christophe Rhodes Date: Sun, 11 Apr 2004 21:10:53 +0000 Subject: [PATCH] 0.8.9.35: Slightly MORE DOCUMENTATION ... minimal, unpolished sb-md5 and sb-rotate-byte documentation ... whitespace fixup in sbcl.texinfo ... add a couple of index terms to sb-aclrepl.texinfo (It Would Be Nice to be able to include contrib docstrings; it ought to be possible, but possibly we need to zap the asdf-install 'binary' and require (ha ha) that REQUIRE should work from within the build tree [with SBCL_HOME set appropriately] on _all_ contribs) --- contrib/sb-aclrepl/sb-aclrepl.texinfo | 2 ++ contrib/sb-md5/sb-md5.texinfo | 21 +++++++++++++++++++++ contrib/sb-rotate-byte/sb-rotate-byte.texinfo | 18 ++++++++++++++++++ doc/manual/docstrings.lisp | 4 ++-- doc/manual/sbcl.texinfo | 16 ++++++++-------- version.lisp-expr | 2 +- 6 files changed, 52 insertions(+), 11 deletions(-) create mode 100644 contrib/sb-md5/sb-md5.texinfo create mode 100644 contrib/sb-rotate-byte/sb-rotate-byte.texinfo diff --git a/contrib/sb-aclrepl/sb-aclrepl.texinfo b/contrib/sb-aclrepl/sb-aclrepl.texinfo index 4a71c0f..ef7b1e4 100644 --- a/contrib/sb-aclrepl/sb-aclrepl.texinfo +++ b/contrib/sb-aclrepl/sb-aclrepl.texinfo @@ -1,5 +1,7 @@ @node sb-aclrepl @section sb-aclrepl +@cindex Read-Eval-Print Loop +@cindex REPL The @code{sb-aclrepl} module offers an AllegroCL style Read-Eval-Print Loop for SBCL. An AllegroCL style inspector is integrated. Adding an diff --git a/contrib/sb-md5/sb-md5.texinfo b/contrib/sb-md5/sb-md5.texinfo new file mode 100644 index 0000000..59858b2 --- /dev/null +++ b/contrib/sb-md5/sb-md5.texinfo @@ -0,0 +1,21 @@ +@node sb-md5 +@section sb-md5 +@cindex Hashing, cryptographic + +The @code{sb-md5} module implements the RFC1321 MD5 Message Digest +Algorithm. + +@comment entry points / docstrings + +@subsection Credits + +The implementation for CMUCL was largely done by Pierre Mai, with help +from members of the @code{cmucl-help} mailing list. Since CMUCL and +SBCL are similar in many respects, it was not too difficult to extend +the low-level implementation optimizations for CMUCL to SBCL. +Following this, SBCL's compiler was extended to implement efficient +compilation of modular arithmetic (@pxref{Modular arithmetic}), which +enabled the implementation to be expressed in portable arithmetical +terms, apart from the use of @code{rotate-byte} for bitwise rotation. +@findex rotate-byte + diff --git a/contrib/sb-rotate-byte/sb-rotate-byte.texinfo b/contrib/sb-rotate-byte/sb-rotate-byte.texinfo new file mode 100644 index 0000000..d599c0d --- /dev/null +++ b/contrib/sb-rotate-byte/sb-rotate-byte.texinfo @@ -0,0 +1,18 @@ +@node sb-rotate-byte +@section sb-rotate-byte +@cindex Modular arithmetic +@cindex Arithmetic, modular +@cindex Arithmetic, hardware + +The @code{sb-rotate-byte} module offers an interface to bitwise +rotation, with an efficient implementation for operations which can be +performed directly using the platform's arithmetic routines. It +implements the specification at +@uref{http://www.cliki.net/ROTATE-BYTE}. +@comment except when someone scribbles all over it. Hmm. + +Bitwise rotation is a component of various cryptographic or hashing +algorithms: MD5, SHA-1, etc.; often these algorithms are specified on +32-bit rings. [cite cite cite]. + +@comment would like to include ROTATE-BYTE's docstring diff --git a/doc/manual/docstrings.lisp b/doc/manual/docstrings.lisp index 717c9eb..a1cd645 100644 --- a/doc/manual/docstrings.lisp +++ b/doc/manual/docstrings.lisp @@ -116,7 +116,7 @@ (package "package") (setf "setf-expander") (structure "struct") - (type (let ((class (ignore-errors (find-class symbol)))) + (type (let ((class (find-class symbol nil)))) (etypecase class (structure-class "struct") (standard-class "class") @@ -139,7 +139,7 @@ (package "@defvr Package") (setf "@deffn {Setf Expander}") (structure "@deftp Structure") - (type (let ((class (ignore-errors (find-class symbol)))) + (type (let ((class (find-class symbol nil)))) (etypecase class (structure-class "@deftp Structure") (standard-class "@deftp Class") diff --git a/doc/manual/sbcl.texinfo b/doc/manual/sbcl.texinfo index 7a00d47..37d0070 100644 --- a/doc/manual/sbcl.texinfo +++ b/doc/manual/sbcl.texinfo @@ -59,16 +59,16 @@ provided with absolutely no warranty. See the @file{COPYING} and @insertcopying @menu -* Introduction:: -* The Compiler:: -* The Debugger:: -* Efficiency:: -* Beyond The ANSI Standard:: +* Introduction:: +* The Compiler:: +* The Debugger:: +* Efficiency:: +* Beyond The ANSI Standard:: * The Foreign Function Interface:: -* Contributed Modules:: +* Contributed Modules:: * Concept Index:: -* Function Index:: -* Variable Index:: +* Function Index:: +* Variable Index:: * Colophon:: @end menu diff --git a/version.lisp-expr b/version.lisp-expr index c2a7105..c6f28d8 100644 --- a/version.lisp-expr +++ b/version.lisp-expr @@ -17,4 +17,4 @@ ;;; checkins which aren't released. (And occasionally for internal ;;; versions, especially for internal versions off the main CVS ;;; branch, it gets hairier, e.g. "0.pre7.14.flaky4.13".) -"0.8.9.34" +"0.8.9.35" -- 1.7.10.4