[cl-store-cvs] CVS update: cl-store/doc/cl-store.texi

[Sean Ross]

Update of /project/cl-store/cvsroot/cl-store/doc
In directory common-lisp.net:/tmp/cvs-serv15959/doc

Modified Files:
	cl-store.texi 
Log Message:
Changelog 2004-11-24 (0.4 Release)
Date: Wed Nov 24 14:27:20 2004
Author: sross

Index: cl-store/doc/cl-store.texi
diff -u cl-store/doc/cl-store.texi:1.2 cl-store/doc/cl-store.texi:1.3
--- cl-store/doc/cl-store.texi:1.2	Wed Nov 10 11:43:26 2004
+++ cl-store/doc/cl-store.texi	Wed Nov 24 14:27:20 2004
@@ -199,12 +199,46 @@
 not be serialized when storing objects.
 @end deftp
 
+
+ at anchor {Variable *store-hash-size*}
+ at vindex *store-hash-size*
+ at deftp {Variable} *store-hash-size* @emph{Default 1000}
+The default size of the hash-table created to keep track of
+objects which have already been stored. By binding the 
+variable to a suitable value you can avoid the consing
+involved by rehashing hash-tables.
+ at end deftp
+
+ at anchor {Variable *restore-hash-size*}
+ at vindex *restore-hash-size*
+ at deftp {Variable} *restore-hash-size* @emph{Default 1000}
+The default size of the hash-table created to keep track of
+objects which have already been restored. By binding the 
+variable to a suitable value you can avoid the consing
+involved by rehashing hash-tables.
+ at end deftp
+
+
+ at anchor {Variable *check-for-circs*}
+ at vindex *check-for-circs*
+ at deftp {Variable} *check-for-circs* @emph{Default t}
+Binding this variable to nil when storing or restoring
+an object inhibits all checks for circularities which gives a 
+severe boost to performance. The downside of this is that no 
+restored objects will be eq and attempting to store circular objects 
+will hang. The speed improvements are definitely worth it if you 
+know that there will be no circularities or shared references in 
+your data (eg spam-filter hash-tables). 
+ at end deftp
+
+
 @anchor {Variable *default-backend*}
 @vindex *default-backend*
 @deftp {Variable} *default-backend* @emph{Default *cl-store-backend*}
 The backend that will be used by default.
 @end deftp
 
+
 @anchor {Variable *cl-store-backend*}
 @vindex *cl-store-backend*
 @deftp {Variable} *cl-store-backend* 
@@ -705,7 +739,7 @@
 @section Known Issues
 @itemize @bullet
 @item  CLISP, OpenMCL, Allegro CL cannot store structure instances.
- at item  Structure definitions aren't supported.
+ at item  Structure definitions are only supported in SBCL.
 @item  MOP classes aren't supported.
 @item  Due to the fact that function's aren't fully supported CLOS Classes initfunction slot cannot be serialized.
 @end itemize