[elephant-cvs] CVS elephant/doc
ieslick
ieslick at common-lisp.net
Sat Apr 28 14:24:57 UTC 2007
Update of /project/elephant/cvsroot/elephant/doc
In directory clnet:/tmp/cvs-serv26611
Modified Files:
Makefile data-store-reference.texinfo elephant.texinfo
installation.texinfo intro.texinfo reference.texinfo
user-guide.texinfo
Log Message:
Final doc cleanup; added contents to PDF (finally)
--- /project/elephant/cvsroot/elephant/doc/Makefile 2007/04/01 14:33:24 1.6
+++ /project/elephant/cvsroot/elephant/doc/Makefile 2007/04/28 14:24:57 1.7
@@ -9,4 +9,5 @@
makeinfo -v --html --css-include=style.css --force --no-split elephant.texinfo
pdf: includes-stuff
- texi2dvi --pdf elephant.texinfo
+ texi2pdf --texinfo=@setcontentsaftertitlepage --texinfo=@setshortcontentsaftertitlepage \
+ elephant.texinfo
--- /project/elephant/cvsroot/elephant/doc/data-store-reference.texinfo 2007/04/28 02:31:07 1.8
+++ /project/elephant/cvsroot/elephant/doc/data-store-reference.texinfo 2007/04/28 14:24:57 1.9
@@ -28,12 +28,12 @@
* Registration: DSR Registration. Register the data store for the appropriate controller specifications.
* Store Controllers: DSR Store Controllers. Subclassing the store controller.
* Handling Serialization: DSR Handling Serialization. Available facilities for serializing objects.
-* Memory Utilities: DSR Memory Utilities. Writing primitive C types.
* Persistent Objects and Slot access: DSR Persistent Objects and Slot Access. Support for metaprotocol slot access.
* Collections: DSR Collections. BTrees and indices.
* Cursors: DSR Cursors. Traversing BTrees.
* Transactions: DSR Transactions. Transaction implementation.
* Multithreading Considerations: DSR Multithreading Considerations. Multithreading considerations.
+ at c * Memory Utilities: DSR Memory Utilities. Writing primitive C types.
@c * Foreign Libraries: DSR Foreign Libraries. Using UFFI and ASDF to build or link foreign libraries
@end menu
@@ -241,7 +241,7 @@
@node DSR Handling Serialization
@comment node-name, next, previous, up
@section Handling Serialization
- at cindex Serialization
+ at cindex Serializer
Data stores must initialize @ref{Class elephant:store-controller} with
internal serializer functions. Packages @code{elephant-serializer1}
--- /project/elephant/cvsroot/elephant/doc/elephant.texinfo 2007/04/28 02:31:07 1.11
+++ /project/elephant/cvsroot/elephant/doc/elephant.texinfo 2007/04/28 14:24:57 1.12
@@ -2,9 +2,10 @@
@c %**start of header
@setfilename elephant.info
@settitle Elephant User Manual
- at setchapternewpage odd
@c %**end of header
+ at setchapternewpage odd
+
@copying
@quotation
Elephant System @*
@@ -44,7 +45,6 @@
@top Copyright
@insertcopying
- at end ifnottex
@ifhtml
@menu
@@ -74,13 +74,14 @@
* Variable Index::
* Colophon::
@end menu
-
@end ifhtml
@node Table of Contents
@unnumbered
@comment node-name, next, previous, up
- at contents
+ at contents
+
+ at end ifnottex
@include intro.texinfo
@include tutorial.texinfo
@@ -131,4 +132,8 @@
@uref{http://www.common-lisp.net/project/elephant/}) and submit a
patch.
+ at iftex
+ at shortcontents
+ at contents
+ at end iftex
@bye
--- /project/elephant/cvsroot/elephant/doc/installation.texinfo 2007/04/28 02:31:07 1.12
+++ /project/elephant/cvsroot/elephant/doc/installation.texinfo 2007/04/28 14:24:57 1.13
@@ -11,7 +11,7 @@
* Loading Elephant:: Loading Elephant and the data store loading protocol.
* Berkeley DB:: Installing support for the Berkeley DB data store.
* Berkeley DB Example:: An example of installing and running the Berkeley DB data store.
-* Upgrading Berkeley DB Database:: How to upgrade to a new version of Berkeley DB.
+* Upgrading Berkeley DB Databases:: How to upgrade to a new version of Berkeley DB.
* CL-SQL:: Install and connecting to the CL-SQL data store.
* CL-SQL Example:: An example of using the CL-SQL data store.
* Elephant on Windows:: More details about running Elephant on Windows
@@ -309,8 +309,8 @@
@item Open your old database: @code{(setf sc (open-store '(:BDB "/Users/me/db/ele060/")))}
@item Run upgrade: @code{(upgrade sc '(:BDB "/Users/me/db/ele061/"))}
@end itemize
- at item Test your new application and report any bugs that arise to elephant-devel at common-lisp.net
- at end itemize
+ at item Test your new application and report any bugs that arise to @email{elephant-devel@@common-lisp.net}
+ at end enumerate
@emph{(NOTE: close-store may fail when closing the old 0.6 database, this is OK.)}
--- /project/elephant/cvsroot/elephant/doc/intro.texinfo 2007/04/02 00:51:06 1.6
+++ /project/elephant/cvsroot/elephant/doc/intro.texinfo 2007/04/28 14:24:57 1.7
@@ -3,7 +3,9 @@
@node Introduction
@comment node-name, next, previous, up
@chapter Introduction
- at cindex Introduction
+ at cindex History
+ at cindex Goals
+
Elephant is a persistent object protocol and database for Common
Lisp. The persistent protocol component of elephant overrides class
--- /project/elephant/cvsroot/elephant/doc/reference.texinfo 2007/04/28 02:31:07 1.14
+++ /project/elephant/cvsroot/elephant/doc/reference.texinfo 2007/04/28 14:24:57 1.15
@@ -7,22 +7,22 @@
@cindex API Reference
@menu
-* Store Controllers:: Connecting to a data store.
-* Persistent Object API:: Defining persistent classes and creating and manipulating persistent indices.
-* Persistent Object Indexing API:: Convenient indexing of persistent classes.
-* Persistent Set API:: Maintaining persistent collections the easy way.
+* Store Controllers: Store Controller API. Connecting to a data store.
+* Persistent Objects: Persistent Object API. Defining persistent classes and creating and manipulating persistent indices.
+* Persistent Object Indexing: Persistent Object Indexing API. Convenient indexing of persistent classes.
+* Persistent Sets: Persistent Set API. Maintaining persistent collections the easy way.
@c * Query Interfaces:: Finding instances.
-* BTree API:: BTrees and indices, a low level persistent data structure.
-* Cursor API:: Traversing BTrees.
-* Index Cursor API:: Traversing BTree Indicies.
-* Transaction API:: Transaction functions.
-* Migration and Upgrading API:: Migration and upgrading.
-* Miscellaneous API:: Other functions and data store specific functions
+* BTrees: BTree API. BTrees and indices, a low level persistent data structure.
+* BTree Cursors: BTree Cursor API. Traversing BTrees.
+* Index Cursors: Index Cursor API. Traversing BTree Indicies.
+* Transactions: Transaction API. Transaction functions.
+* Migration and Upgrading: Migration and Upgrading API. Migration and upgrading.
+ at c * Miscellaneous API:: Other functions and data store specific functions
@end menu
@node Store Controller API
@comment node-name, next, previous, up
- at section Store Controller API
+ at section Store Controllers
@cindex Store Controller
@cindex API
@@ -49,7 +49,7 @@
@node Persistent Object API
@comment node-name, next, previous, up
- at section Persistent Object API
+ at section Persistent Objects
@cindex Persistent Objects
@cindex API
@@ -63,7 +63,7 @@
@node Persistent Object Indexing API
@comment node-name, next, previous, up
- at section Persistent Object Indexing API
+ at section Persistent Object Indexing
@cindex Persistent Object Indexing
@cindex API
@@ -100,8 +100,8 @@
@node Persistent Set API
@comment node-name, next, previous, up
- at section Persistent Set API
- at cindex Persistent Set API
+ at section Persistent Sets
+ at cindex Persistent Sets
Persistent sets are a simple persistent collection abstraction. They
maintain an unordered collection of objects. Unlike the normal
@@ -132,7 +132,7 @@
@node BTree API
@comment node-name, next, previous, up
- at section BTree API
+ at section BTrees
@cindex BTree
@cindex API
@@ -167,9 +167,9 @@
@include includes/fun-elephant-map-index.texinfo
- at node Cursor API
+ at node BTree Cursor API
@comment node-name, next, previous, up
- at section Cursor API
+ at section Btree Cursors
@cindex Cursors
@cindex API
@@ -200,7 +200,7 @@
@node Index Cursor API
@comment node-name, next, previous, up
- at section Index Cursor API
+ at section Index Cursors
@cindex Cursor
@cindex Index
@cindex Indices
@@ -239,7 +239,7 @@
@node Transaction API
@comment node-name, next, previous, up
- at section Transaction API
+ at section Transactions
@cindex Transaction API
@cindex API
@@ -256,7 +256,7 @@
@node Migration and Upgrading API
@comment node-name, next, previous, up
- at section Migration and Upgrading API
+ at section Migration and Upgrading
@cindex Migration and Upgrading
@cindex API
--- /project/elephant/cvsroot/elephant/doc/user-guide.texinfo 2007/04/28 02:31:11 1.20
+++ /project/elephant/cvsroot/elephant/doc/user-guide.texinfo 2007/04/28 14:24:57 1.21
@@ -882,7 +882,7 @@
setting a second cursor to the same location.
Cursors can be in two states: initialized and uninitialized.
- at ref{Cursor API} for details.
+ at ref{BTree Cursor API} for details.
To initialize a cursor, you have to use one of the initializing
functions to select a key-value pair in the btree.
@@ -1068,6 +1068,7 @@
that the cursor is now uninitialized (@code{cursor-initialized-p}) and
needs to be reset by a set or set both call.
+ at xref{Index Cursor API} for further details.
@node Multi-threaded Applications
@comment node-name, next, previous, up
More information about the Elephant-cvs
mailing list