This tag was made prematurely -- get rid of it.

tags/3.3b1/COPYING

-See:
-
- - the copyright notice in: COPYRIGHT.txt
-
- - The Zope Public License in LICENSE.txt

tags/3.3b1/COPYRIGHT.txt

-Copyright (c) 2004 Zope Corporation and Contributors.
-All Rights Reserved.
-
-This software is subject to the provisions of the Zope Public License,
-Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
-THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
-WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
-FOR A PARTICULAR PURPOSE.

tags/3.3b1/LICENSE.txt

-Zope Public License (ZPL) Version 2.1
--------------------------------------
-
-A copyright notice accompanies this license document that
-identifies the copyright holders.
-
-This license has been certified as open source. It has also
-been designated as GPL compatible by the Free Software
-Foundation (FSF).
-
-Redistribution and use in source and binary forms, with or
-without modification, are permitted provided that the
-following conditions are met:
-
-1. Redistributions in source code must retain the
-   accompanying copyright notice, this list of conditions,
-   and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the accompanying
-   copyright notice, this list of conditions, and the
-   following disclaimer in the documentation and/or other
-   materials provided with the distribution.
-
-3. Names of the copyright holders must not be used to
-   endorse or promote products derived from this software
-   without prior written permission from the copyright
-   holders.
-
-4. The right to distribute this software or to use it for
-   any purpose does not give you the right to use
-   Servicemarks (sm) or Trademarks (tm) of the copyright
-   holders. Use of them is covered by separate agreement
-   with the copyright holders.
-
-5. If any files are modified, you must cause the modified
-   files to carry prominent notices stating that you changed
-   the files and the date of any change.
-
-Disclaimer
-
-  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS''
-  AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
-  NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
-  AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
-  NO EVENT SHALL THE COPYRIGHT HOLDERS BE
-  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
-  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
-  OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
-  DAMAGE.

tags/3.3b1/MANIFEST.in

-include MANIFEST MANIFEST.in
-include *.txt
-include test.py log.ini
-recursive-include src *.h *.c *.xml *.txt *.sh *.conf *.bat
-include src/ZConfig/scripts/zconfig
-graft doc
-graft src/scripts
-graft src/ZConfig/doc
-global-exclude .cvsignore

tags/3.3b1/README.txt

-ZODB3 3.3 beta 1
-================
-
-Introduction
-------------
-
-The ZODB3 package provides a set of tools for using the Zope Object
-Database (ZODB) in Python programs separately from Zope.  The tools
-you get are identical to the ones provided in Zope, because they come
-from the same source repository.  They have been packaged for use in
-non-Zope stand-alone Python applications.
-
-The components you get with the ZODB3 release are as follows:
-
-- Core ZODB, including the persistence machinery
-- Standard storages such as FileStorage
-- The persistent BTrees modules
-- ZEO
-- ZConfig -- a Zope configuration language
-- documentation
-
-Our primary development platforms are Linux and Windows 2000.  The
-test suite should pass without error on all of these platforms,
-although it can take a long time on Windows -- longer if you use
-ZoneAlarm.  Many particularly slow tests are skipped unless you pass
---all as an argument to test.py.
-
-Compatibility
--------------
-
-ZODB 3.3 is known to work with Python 2.3.3.  For best results, we
-recommend using Python 2.3.4.  Note that Python 2.2 and earlier are
-not supported.
-
-The Zope 2.8 release should be compatible with this version of ZODB.
-Note that Zope 2.7 and higher includes ZEO, so this package should
-only be needed to run a ZEO server.
-
-The ZEO server in ZODB 3.3 is currently incompatible with earlier
-versions of ZODB.  If you want to test the software, you must be
-running this release for both client and server.  A backwards
-compatibility mechanism may be provided in a beta release.
-
-Prerequisites
--------------
-
-You must have Python installed.  If you've installed Python from RPM,
-be sure that you've installed the development RPMs too, since ZODB3
-builds Python extensions.  If you have the source release of ZODB3,
-you will need a C compiler.
-
-Installation
-------------
-
-ZODB3 is released as a distutils package.  To build it, run the setup
-script::
-
-    % python setup.py build
-
-To test the build, run the test script::
-
-    % python test.py
-
-For more verbose test output, append one or two '-v' arguments to this
-command.
-
-If all the tests succeeded, you can install ZODB3 using the setup
-script::
-
-    % python setup.py install
-
-This should now make all of ZODB accessible to your Python programs.
-
-Testing
--------
-
-ZODB3 comes with a large test suite that can be run from the source
-directory before ZODB is installed.  The simplest way to run the tests
-is::
-
-    % python test.py -v
-
-This command will run all the tests, printing a single dot for each
-test.  When it finishes, it will print a test summary.  The exact
-number of tests can vary depending on platform and available
-third-party libraries.::
-
-    Ran 1182 tests in 241.269s
-
-    OK
-
-The test script has many more options.  Use the ``-h`` or ``--help``
-options to see a file list of options.  The default test suite omits
-several tests that depend on third-party software or that take a long
-time to run.  To run all the available tests use the ``--all`` option.
-Running all the tests takes much longer.::
-
-    Ran 1561 tests in 1461.557s
-
-    OK
-
-
-History
--------
-
-The version numbering scheme for ZODB is complicated.  Starting with
-the ZODB 3.1 release, we tried to make it simpler.  Versions prior to
-3.1 had different names and different numbers.  This section describes
-the gory details.
-
-Historically, ZODB was distributed as a part of the Zope application
-server.  Jim Fulton's paper at the Python conference in 2000 described
-a version of ZODB he called ZODB 3, based on an earlier persistent
-object system called BoboPOS.  The earliest versions of ZODB 3 were
-released with Zope 2.0.
-
-Andrew Kuchling extracted ZODB from Zope 2.4.1 and packaged it for
-use by standalone Python programs.  He called this version
-"StandaloneZODB".  Andrew's guide to using ZODB is included in the Doc
-directory.  This version of ZODB was hosted at
-http://sf.net/projects/zodb.  It supported Python 1.5.2, and might
-still be of interest to users of this very old Python version.
-
-Zope Corporation released a version of ZODB called "StandaloneZODB
-1.0" in Feb. 2002.  This release was based on Andrew's packaging, but
-built from the same CVS repository as Zope.  It is roughly equivalent
-to the ZODB in Zope 2.5.
-
-Why not call the current release StandaloneZODB?  The name
-StandaloneZODB is a bit of a mouthful.  The standalone part of the
-name suggests that the Zope version is the real version and that this
-is an afterthought, which isn't the case.  So we're calling this
-release "ZODB3".
-
-To make matters worse, we worked on a ZODB4 package for a while and
-made a couple of alpha releases.  We've now abandoned that effort,
-because we didn't have the resources to pursue while also maintaining
-ZODB3.
-
-License
--------
-
-ZODB is distributed under the Zope Public License, an OSI-approved
-open source license.  Please see the LICENSE.txt file for terms and
-conditions.
-
-The ZODB/ZEO Programming Guide included in the documentation is a
-modified version of Andrew Kuchling's original guide, provided under
-the terms of the GNU Free Documentation License.
-
-
-More information
-----------------
-
-We maintain a Wiki page about all things ZODB, including status on
-future directions for ZODB.  Please see
-
-    http://www.zope.org/Wikis/ZODB
-
-and feel free to contribute your comments.  There is a Mailman mailing
-list in place to discuss all issues related to ZODB.  You can send
-questions to
-
-    zodb-dev@zope.org
-
-or subscribe at
-
-    http://lists.zope.org/mailman/listinfo/zodb-dev
-
-and view its archives at
-
-    http://lists.zope.org/pipermail/zodb-dev
-
-Andrew's ZODB Programmers Guide is made available in several
-forms, including DVI and HTML.  To view it online, point your
-browser at the file Doc/guide/zodb/index.html
-
-
-Bugs and Patches
-----------------
-
-Bug reports and patches should be added to the Zope Collector, with
-topic "Database":
-
-    http://collector.zope.org/Zope
-
-
-..
-   Local Variables:
-   mode: indented-text
-   indent-tabs-mode: nil
-   sentence-end-double-space: t
-   fill-column: 70
-   End:

tags/3.3b1/doc/ACKS

-Acknowledgments
----------------
-
-This file lists people who have contribute code, bug fixes, ideas, and
-other support for ZODB.  Alas it is probably not complete.
-
-Steve Alexander
-Anthony Baxter
-John Belmonte
-Johan Dahlin
-Toby Dickenson
-Fred L. Drake, Jr.
-Casey Duncan
-Jon Dyte
-Martijn Faassen
-Jim Fulton
-Marius Gedminas
-Florent Guillaume
-Shane Hathaway
-Nicholas Henke
-Jeremy Hylton
-Matt Kromer
-Andrew Kuchling
-Andreas Jung
-Brian Lloyd
-Ken Manheimer
-Dieter Maurer
-Chris McDonough
-Gintautas Miliauskas
-Tim Peters
-Chris Petrilli
-Christian Reis
-Guido van Rossum
-Neil Schemenauer
-Tres Seaver
-Sidnei da Silva
-Evan Simpson
-Kapil Thangavelu
-Jens Vagelpohl
-Greg Ward
-Barry Warsaw
-Chris Withers

tags/3.3b1/doc/Makefile

-MKHOWTO=mkhowto
-
-MKHTML=$(MKHOWTO) --html --iconserver=. --split=4 --dvips-safe
-
-ZODBTEX = guide/gfdl.tex guide/introduction.tex guide/modules.tex \
-	  guide/prog-zodb.tex guide/storages.tex guide/transactions.tex \
-	  guide/zeo.tex guide/zodb.tex 
-
-default: pdf
-all:	 pdf ps html
-
-pdf:	storage.pdf zodb.pdf
-ps:	storage.ps zodb.ps
-
-html:	storage/storage.html zodb/zodb.html
-
-storage.pdf: storage.tex
-	$(MKHOWTO) --pdf $<
-
-storage.ps: storage.tex
-	$(MKHOWTO) --ps $<
-
-storage/storage.html: storage.tex
-	$(MKHTML) storage.tex
-
-zodb.pdf: $(ZODBTEX)
-	$(MKHOWTO) --pdf guide/zodb.tex
-
-zodb.ps: $(ZODBTEX)
-	$(MKHOWTO) --ps guide/zodb.tex
-
-zodb/zodb.html: $(ZODBTEX)
-	$(MKHTML) guide/zodb.tex
-
-clobber:
-	rm -rf storage.pdf storage.ps storage/ zodb.pdf zodb.ps zodb/

tags/3.3b1/doc/README.txt

-ZODB Documentation
-==================
-
-Simple text files
------------------
-
-This is a brief summary of the text documentation included with ZODB.
-Most of the text actually uses the restructured text format.  The
-summary lists the title and path of each document.
-
-BerkeleyDB Storages for ZODB
-Doc/BDBStorage.txt
-
-Using zdctl and zdrun to manage server processes
-Doc/zdctl.txt
-
-ZEO Client Cache
-Doc/ZEO/cache.txt
-
-Running a ZEO Server HOWTO
-Doc/ZEO/howto.txt
-
-ZEO Client Cache Tracing
-Doc/ZEO/trace.txt
-
-Formatted documents
--------------------
-
-There are two documents written the Python documentation tools.
-
-  ZODB/ZEO Programming Guide
-    PDF:  zodb.pdf
-    HTML: zodb/zodb.html
-
-  ZODB Storage API
-    PDF:  storage.pdf
-    HTML: storage/storage.html
-
-The documents located here can be formatted using the mkhowto script
-which is part of the Python documentation tools.  The recommended use
-of this script is to create a symlink from some handy bin/ directory
-to the script, located in Doc/tools/mkhowto in the Python source
-distribution; that script will locate the various support files it
-needs appropriately.
-
-The Makefile contains the commands to produce both the PDF and HTML
-versions of the documents.

tags/3.3b1/doc/ZConfig/Makefile

-##############################################################################
-#
-# Copyright (c) 2002, 2003 Zope Corporation and Contributors.
-# All Rights Reserved.
-#
-# This software is subject to the provisions of the Zope Public License,
-# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
-# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
-# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
-# FOR A PARTICULAR PURPOSE.
-#
-##############################################################################
-
-# Rules to convert the documentation to a single PDF file.
-#
-# PostScript, HTML, and plain text output are also supported, though
-# PDF is the default.
-#
-# See the README.txt file for information on the mkhowto program used
-# to generate the formatted versions of the documentation.
-
-.PHONY:	default all html pdf ps text
-
-default:  pdf
-all:	  html pdf ps text
-
-html:   zconfig/zconfig.html
-pdf:	zconfig.pdf
-ps:	zconfig.ps
-text:   zconfig.txt
-
-zconfig/zconfig.html:  zconfig.tex schema.dtd xmlmarkup.perl
-	mkhowto --html $<
-
-zconfig.pdf:  zconfig.tex schema.dtd xmlmarkup.sty
-	mkhowto --pdf $<
-
-zconfig.ps:  zconfig.tex schema.dtd xmlmarkup.sty
-	mkhowto --postscript $<
-
-zconfig.txt: zconfig.tex schema.dtd xmlmarkup.sty
-	mkhowto --text $<
-
-clean:
-	rm -f zconfig.l2h zconfig.l2h~
-
-clobber:  clean
-	rm -f zconfig.pdf zconfig.ps zconfig.txt
-	rm -rf zconfig

tags/3.3b1/doc/ZConfig/README.txt

-The zconfig.tex document in this directory contains the reference
-documentation for the ZConfig package.  This documentation is written
-using the Python LaTeX styles.
-
-To format the documentation, get a copy of the Python documentation
-tools (the Doc/ directory from the Python sources), and create a
-symlink to the tools/mkhowto script from some convenient bin/
-directory.  You will need to have a fairly complete set of
-documentation tools installed on your platform; see
-
-    http://www.python.org/doc/current/doc/doc.html
-
-for more information on the tools.
-
-This documentation requires the latest version of the Python
-documentation tools from CVS.

tags/3.3b1/doc/ZConfig/schema.dtd

-<!--
-  *************************************************************************
-  Copyright (c) 2002, 2003 Zope Corporation and Contributors.
-  All Rights Reserved.
-
-  This software is subject to the provisions of the Zope Public License,
-  Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
-  THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
-  WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-  WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
-  FOR A PARTICULAR PURPOSE.
-  *************************************************************************
-
-  Please note that not all documents that conform to this DTD are
-  legal ZConfig schema.  The ZConfig reference manual describes many
-  constraints that are important to understanding ZConfig schema.
-  -->
-
-<!-- DTD for ZConfig schema documents. -->
-
-<!ELEMENT schema (description?, metadefault?, example?,
-                  import*,
-                  (sectiontype | abstracttype)*,
-                  (section | key | multisection | multikey)*)>
-<!ATTLIST schema
-          extends    NMTOKEN  #IMPLIED
-          prefix     NMTOKEN  #IMPLIED
-          handler    NMTOKEN  #IMPLIED
-          keytype    NMTOKEN  #IMPLIED
-          datatype   NMTOKEN  #IMPLIED>
-
-<!ELEMENT component (description?, (sectiontype | abstracttype)*)>
-<!ATTLIST component
-          prefix     NMTOKEN  #IMPLIED>
-
-<!ELEMENT import EMPTY>
-<!ATTLIST import
-          file       CDATA    #IMPLIED
-          package    NMTOKEN  #IMPLIED
-          src        CDATA    #IMPLIED>
-
-<!ELEMENT description (#PCDATA)*>
-<!ATTLIST description
-          format     NMTOKEN  #IMPLIED>
-
-<!ELEMENT metadefault (#PCDATA)*>
-<!ELEMENT example     (#PCDATA)*>
-
-<!ELEMENT sectiontype (description?, 
-                       (section | key | multisection | multikey)*)>
-<!ATTLIST sectiontype
-          name       NMTOKEN  #REQUIRED
-          prefix     NMTOKEN  #IMPLIED
-          keytype    NMTOKEN  #IMPLIED
-          datatype   NMTOKEN  #IMPLIED
-          implements NMTOKEN  #IMPLIED
-          extends    NMTOKEN  #IMPLIED>
-
-<!ELEMENT abstracttype (description?)>
-<!ATTLIST abstracttype
-          name       NMTOKEN  #REQUIRED
-          prefix     NMTOKEN  #IMPLIED>
-
-<!ELEMENT default    (#PCDATA)*>
-<!ATTLIST default
-          key        CDATA    #IMPLIED>
-
-<!ELEMENT key (description?, metadefault?, example?, default*)>
-<!ATTLIST key
-          name       CDATA    #REQUIRED
-          attribute  NMTOKEN  #IMPLIED
-          datatype   NMTOKEN  #IMPLIED
-          handler    NMTOKEN  #IMPLIED
-          required   (yes|no) "no"
-          default    CDATA    #IMPLIED>
-
-<!ELEMENT multikey (description?, metadefault?, example?, default*)>
-<!ATTLIST multikey
-          name       CDATA    #REQUIRED
-          attribute  NMTOKEN  #IMPLIED
-          datatype   NMTOKEN  #IMPLIED
-          handler    NMTOKEN  #IMPLIED
-          required   (yes|no) "no">
-
-<!ELEMENT section (description?)>
-<!ATTLIST section
-          name       CDATA    #REQUIRED
-          attribute  NMTOKEN  #IMPLIED
-          type       NMTOKEN  #REQUIRED
-          handler    NMTOKEN  #IMPLIED
-          required   (yes|no) "no">
-
-<!ELEMENT multisection (description?)>
-<!ATTLIST multisection
-          name       CDATA    #REQUIRED
-          attribute  NMTOKEN  #IMPLIED
-          type       NMTOKEN  #REQUIRED
-          handler    NMTOKEN  #IMPLIED
-          required   (yes|no) "no">

tags/3.3b1/doc/ZConfig/xmlmarkup.perl

-##############################################################################
-#
-# Copyright (c) 2003 Zope Corporation and Contributors.
-# All Rights Reserved.
-#
-# This software is subject to the provisions of the Zope Public License,
-# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
-# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
-# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
-# FOR A PARTICULAR PURPOSE.
-#
-##############################################################################
-
-# LaTeX2HTML support for the xmlmarkup package.  Doesn't do indexing.
-
-package main;
-
-
-sub do_cmd_element{
-    local($_) = @_;
-    my $name = next_argument();
-    return "<tt class='element'>$name</tt>" . $_;
-}
-
-sub do_cmd_attribute{
-    local($_) = @_;
-    my $name = next_argument();
-    return "<tt class='attribute'>$name</tt>" . $_;
-}
-
-sub do_env_attributedesc{
-    local($_) = @_;
-    my $name = next_argument();
-    my $valuetype = next_argument();
-    return ("\n<dl class='macrodesc'>"
-            . "\n<dt><b><tt class='macro'>$name</tt></b>"
-            . "&nbsp;&nbsp;&nbsp;($valuetype)"
-            . "\n<dd>"
-            . $_
-            . "</dl>");
-}
-
-sub do_env_elementdesc{
-    local($_) = @_;
-    my $name = next_argument();
-    my $contentmodel = next_argument();
-    return ("\n<dl class='elementdesc'>"
-            . "\n<dt class='start-tag'><tt>&lt;"
-            . "<b class='element'>$name</b>&gt;</tt>"
-            . "\n<dd class='content-model'>$contentmodel"
-            . "\n<dt class='endtag'><tt>&lt;/"
-            . "<b class='element'>$name</b>&gt;</tt>"
-            . "\n<dd class='descrition'>"
-            . $_
-            . "</dl>");
-}
-
-1;				# Must end with this, because Perl is bogus.

tags/3.3b1/doc/ZConfig/xmlmarkup.sty

-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-%
-% Copyright (c) 2003 Zope Corporation and Contributors.
-% All Rights Reserved.
-%
-% This software is subject to the provisions of the Zope Public License,
-% Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
-% THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
-% WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-% WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
-% FOR A PARTICULAR PURPOSE.
-%
-%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
-
-% Define some simple markup for the LaTeX command documentation:
-
-\ProvidesPackage{xmlmarkup}
-\RequirePackage{python}      % fulllineitems environment
-
-\newcommand{\element}[1]{\code{#1}}
-\newcommand{\attribute}[1]{\code{#1}}
-
-% \begin{elementdesc}{type}{content-model}
-\newenvironment{elementdesc}[2]{
-  \begin{fulllineitems}
-    \item[\code{\textless{\bfseries #1}\textgreater}]
-    \code{#2}
-    \item[\code{\textless/{\bfseries #1}\textgreater}]
-    \index{#1 element@\py@idxcode{#1} element}
-    \index{elements!#1@\py@idxcode{#1}}
-}{\end{fulllineitems}}
-
-% \begin{attributedesc}{name}{content-type}
-\newenvironment{attributedesc}[2]{
-  \begin{fulllineitems}
-    \item[\code{\bfseries#1}{\quad(#2)}]
-    \index{#1@\py@idxcode{#1}}
-}{\end{fulllineitems}}

tags/3.3b1/doc/ZEO/README.txt

-ZEO Documentation
-=================
-
-This directory contains ZEO documentation.
-
-howto.txt
-    The first place to look.
-
-    It provides a high-level overview of ZEO features and details on
-    how to install and configure clients and servers.  Includes a 
-    configuration reference.
-
-cache.txt
-    Explains how the client cache works.
-    
-trace.txt
-    Describe cache trace tool used to determine ideal cache size.
-
-ZopeREADME.txt
-    A somewhat dated description of how to integrate ZEO with Zope.
-    It provides a few hints that are not yet in howto.txt.

tags/3.3b1/doc/ZEO/ZopeREADME.txt

-Zope Enterprise Objects (ZEO)
-
-  Installation
-
-    ZEO 2.0 requires Zope 2.4 or higher and Python 2.1 or higher.
-    If you use Python 2.1, we recommend the latest minor release
-    (2.1.3 as of this writing) because it includes a few bug fixes
-    that affect ZEO.
-
-    Put the package (the ZEO directory, without any wrapping directory
-    included in a distribution) in your Zope lib/python.
-
-    The setup.py script in the top-level ZEO directory can also be
-    used.  Run "python setup.py install --home=ZOPE" where ZOPE is the
-    top-level Zope directory.
-
-    You can test ZEO before installing it with the test script::
-
-      python test.py -v
-
-    Run the script with the -h option for a full list of options.  The
-    ZEO 2.0b2 release contains 122 unit tests on Unix.
-
-  Starting (and configuring) the ZEO Server
-
-    To start the storage server, go to your Zope install directory and
-    run::
-
-      python lib/python/ZEO/start.py -p port_number
-
-    This run the storage sever under zdaemon.  zdaemon automatically
-    restarts programs that exit unexpectedly.
-
-    The server and the client don't have to be on the same machine.
-    If they are on the same machine, then you can use a Unix domain
-    socket::
-
-      python lib/python/ZEO/start.py -U filename
-
-    The start script provides a number of options not documented here.
-    See doc/start.txt for more information.
-        
-  Running Zope as a ZEO client
-
-    To get Zope to use the server, create a custom_zodb module,
-    custom_zodb.py, in your Zope install directory, so that Zope uses a
-    ClientStorage::
-
-      from ZEO.ClientStorage import ClientStorage
-      Storage = ClientStorage(('', port_number))
-
-    You can specify a host name (rather than '') if you want.  The port
-    number is, of course, the port number used to start the storage
-    server.
-
-    You can also give the name of a Unix domain socket file::
-
-      from ZEO.ClientStorage import ClientStorage
-      Storage = ClientStorage(filename)
-
-    There are a number of configuration options available for the
-    ClientStorage. See doc/ClientStorage.txt for details.
-
-    If you want a persistent client cache which retains cache contents
-    across ClientStorage restarts, you need to define the environment
-    variable, ZEO_CLIENT, or set the client keyword argument to the
-    constructor to a unique name for the client.  This is needed so
-    that unique cache name files can be computed.  Otherwise, the
-    client cache is stored in temporary files which are removed when
-    the ClientStorage shuts down.  For example, to start two Zope
-    processes with unique caches, use something like::
-
-      python z2.py -P8700 ZEO_CLIENT=8700
-      python z2.py -P8800 ZEO_CLIENT=8800
-
-  Zope product installation
-
-    Normally, Zope updates the Zope database during startup to reflect
-    product changes or new products found. It makes no sense for
-    multiple ZEO clients to do the same installation. Further, if
-    different clients have different software installed, the correct
-    state of the database is ambiguous.
-
-    Zope will not modify the Zope database during product installation
-    if the environment variable ZEO_CLIENT is set.
-
-    Normally, Zope ZEO clients should be run with ZEO_CLIENT set so
-    that product initialization is not performed.
-
-    If you do install new Zope products, then you need to take a
-    special step to cause the new products to be properly registered
-    in the database.  The easiest way to do this is to start Zope
-    once with the environment variable FORCE_PRODUCT_LOAD set.
-
-    The interaction between ZEO and Zope product installation is
-    unfortunate.

tags/3.3b1/doc/ZEO/cache.txt

-ZEO Client Cache
-
-  The Client cache provides a disk based cache for each ZEO client.
-  The client cache allows reads to be done from local disk rather than
-  by remote access to the storage server.
-
-  The cache may be persistent or transient. If the cache is
-  persistent, then the cache files are retained for use after process
-  restarts. A non-persistent cache uses temporary files that are
-  removed when the client storage is closed.
-
-  The client cache is managed as two files. The cache manager
-  endeavors to maintain the two files at sizes less than or equal to
-  one half the cache size.  One of the cache files is designated the
-  "current" cache file. The other cache file is designated the "old"
-  cache file, if it exists.  All writes are done to the current cache
-  files.  When transactions are committed on the client, transactions
-  are not split between cache files. Large transactions may cause
-  cache files to be larger than one half the target cache size.
-
-  The life of the cache is as follows:
-
-  - When the cache is created, the first of the two cache files is
-    created and designated the "current" cache file.
-
-  - Cache records are written to the cache file, either as
-    transactions commit locally, or as data are loaded from the
-    server.
-
-  - When the cache file size exceeds one half the cache size, the
-    second cache file is created and designated the "current" cache
-    file.  The first cache file becomes the "old" cache file.
-
-  - Cache records are written to the new current cache file, either as
-    transactions commit locally, or as data are loaded from the
-    server.
-
-  - When a cache hit is found in the old cache file, it is copied to
-    the current cache file.
-
-  - When the current cache file size exceeds one half the cache size, the
-    first cache file is recreated and designated the "current" cache
-    file.  The second cache file becomes the "old" cache file.
-
-  and so on.
-
-  Persistent cache files are created in the directory named in the
-  'var' argument to the ClientStorage (see ClientStorage.txt) or in
-  the 'var' subdirectory of the directory given by the INSTANCE_HOME
-  builtin (created by Zope), or in the current working directory.
-  Persistent cache files have names of the form::
-
-    cstorage-client-n.zec
-
-  where:
-
-    storage -- the storage name
-
-    client -- the client name, as given by the 'ZEO_CLIENT' environment
-      variable or the 'client' argument provided when creating a client
-      storage.
-
-    n -- '0' for the first cache file and '1' for the second. 
-
-  For example, the second cache file for storage 'spam' and client 8881
-  would be named 'cspam-8881-1.zec'.
-

tags/3.3b1/doc/ZEO/trace.txt

-ZEO Client Cache Tracing
-========================
-
-An important question for ZEO users is: how large should the ZEO
-client cache be?  ZEO 2 (as of ZEO 2.0b2) has a new feature that lets
-you collect a trace of cache activity and tools to analyze this trace,
-enabling you to make an informed decision about the cache size.
-
-Don't confuse the ZEO client cache with the Zope object cache.  The
-ZEO client cache is only used when an object is not in the Zope object
-cache; the ZEO client cache avoids roundtrips to the ZEO server.
-
-Enabling Cache Tracing
-----------------------
-
-To enable cache tracing, set the environment variable ZEO_CACHE_TRACE
-to the name of a file to which the ZEO client process can write.  ZEO
-will append a hyphen and the storage name to the filename, to
-distinguish different storages.  If the file doesn't exist, the ZEO
-will try to create it.  If there are problems with the file, a log
-message is written to the standard Zope log file.  To start or stop
-tracing, the ZEO client process (typically a Zope application server)
-must be restarted.
-
-The trace file can grow pretty quickly; on a moderately loaded server,
-we observed it growing by 5 MB per hour.  The file consists of binary
-records, each 24 bytes long; a detailed description of the record
-lay-out is given in stats.py.  No sensitive data is logged.
-
-Analyzing a Cache Trace
------------------------
-
-The stats.py command-line tool is the first-line tool to analyze a
-cache trace.  Its default output consists of two parts: a one-line
-summary of essential statistics for each segment of 15 minutes,
-interspersed with lines indicating client restarts and "cache flip
-events" (more about those later), followed by a more detailed summary
-of overall statistics.
-
-The most important statistic is probably the "hit rate", a percentage
-indicating how many requests to load an object could be satisfied from
-the cache.  Hit rates around 70% are good.  90% is probably close to
-the theoretical maximum.  If you see a hit rate under 60% you can
-probably improve the cache performance (and hence your Zope
-application server's performance) by increasing the ZEO cache size.
-This is normally configured using the cache_size keyword argument to
-the ClientStorage() constructor in your custom_zodb.py file.  The
-default cache size is 20 MB.
-
-The stats.py tool shows its command line syntax when invoked without
-arguments.  The tracefile argument can be a gzipped file if it has a
-.gz extension.  It will read from stdin (assuming uncompressed data)
-if the tracefile argument is '-'.
-
-Simulating Different Cache Sizes
---------------------------------
-
-Based on a cache trace file, you can make a prediction of how well the
-cache might do with a different cache size.  The simul.py tool runs an
-accurate simulation of the ZEO client cache implementation based upon
-the events read from a trace file.  A new simulation is started each
-time the trace file records a client restart event; if a trace file
-contains more than one restart event, a separate line is printed for
-each simulation, and line with overall statistics is added at the end.
-
-Example, assuming the trace file is in /tmp/cachetrace.log::
-
-    $ python simul.py -s 100 /tmp/cachetrace.log
-      START TIME  DURATION    LOADS     HITS INVALS WRITES  FLIPS HITRATE
-    Sep  4 11:59     38:01    59833    40473    257     20      2  67.6%
-    $
-
-This shows that with a 100 MB cache size, the cache hit rate is
-67.6%.  So let's try this again with a 200 MB cache size::
-
-    $ python simul.py -s 200 /tmp/cachetrace.log
-      START TIME  DURATION    LOADS     HITS INVALS WRITES  FLIPS HITRATE
-    Sep  4 11:59     38:01    59833    40921    258     20      1  68.4%
-    $
-
-This showed hardly any improvement.  So let's try a 300 MB cache
-size::
-
-    $ python2.0 simul.py -s 300 /tmp/cachetrace.log
-    ZEOCacheSimulation, cache size 300,000,000 bytes
-      START TIME  DURATION    LOADS     HITS INVALS WRITES  FLIPS HITRATE
-    Sep  4 11:59     38:01    59833    40921    258     20      0  68.4%
-    $ 
-
-This shows that for this particular trace file, the maximum attainable
-hit rate is 68.4%.  This is probably caused by the fact that nearly a
-third of the objects mentioned in the trace were loaded only once --
-the cache only helps if an object is loaded more than once.
-
-The simul.py tool also supports simulating different cache
-strategies.  Since none of these are implemented, these are not
-further documented here.
-
-Cache Flips
------------
-
-The cache uses two files, which are managed as follows:
-
-  - Data are written to file 0 until file 0 exceeds limit/2 in size.
-
-  - Data are written to file 1 until file 1 exceeds limit/2 in size.
-
-  - File 0 is truncated to size 0 (or deleted and recreated).
-
-  - Data are written to file 0 until file 0 exceeds limit/2 in size.
-
-  - File 1 is truncated to size 0 (or deleted and recreated).
-
-  - Data are written to file 1 until file 1 exceeds limit/2 in size.
-
-and so on.
-
-A switch from file 0 to file 1 is called a "cache flip".  At all cache
-flips except the first, half of the cache contents is wiped out.  This
-affects cache performance.  How badly this impact is can be seen from
-the per-15-minutes summaries printed by stats.py.  The -i option lets
-you choose a smaller summary interval which shows the impact more
-acutely.
-
-The simul.py tool shows the number of cache flips in the FLIPS column.
-If you see more than one flip per hour the cache may be too small.

tags/3.3b1/doc/guide/README

-This directory contains Andrew Kuchling's programmer's guide to ZODB
-and ZEO.  It was originally taken from Andrew's zodb.sf.net project on
-SourceForge.  Because the original version is no longer updated, this
-version is best viewed as an independent fork now.

tags/3.3b1/doc/guide/TODO

-Write section on __setstate__
-Continue working on it
-Suppress the full GFDL text in the PDF/PS versions
-

tags/3.3b1/doc/guide/admin.tex

-
-%  Administration
-%    Importing and exporting data
-%    Disaster recovery/avoidance
-%    Security
-

tags/3.3b1/doc/guide/chatter.py

-
-import sys, time, os, random
-
-import transaction
-from persistent import Persistent
-
-from ZEO import ClientStorage
-import ZODB
-from ZODB.POSException import ConflictError
-from BTrees import OOBTree
-
-class ChatSession(Persistent):
-
-    """Class for a chat session.
-    Messages are stored in a B-tree, indexed by the time the message
-    was created.  (Eventually we'd want to throw messages out,
-
-    add_message(message) -- add a message to the channel
-    new_messages()       -- return new messages since the last call to
-                            this method
-
-
-    """
-
-    def __init__(self, name):
-        """Initialize new chat session.
-        name -- the channel's name
-        """
-
-        self.name = name
-
-        # Internal attribute: _messages holds all the chat messages.
-        self._messages = OOBTree.OOBTree()
-
-
-    def new_messages(self):
-        "Return new messages."
-
-        # self._v_last_time is the time of the most recent message
-        # returned to the user of this class.
-        if not hasattr(self, '_v_last_time'):
-            self._v_last_time = 0
-
-        new = []
-        T = self._v_last_time
-
-        for T2, message in self._messages.items():
-            if T2 > T:
-                new.append( message )
-                self._v_last_time = T2
-
-        return new
-
-    def add_message(self, message):
-        """Add a message to the channel.
-        message -- text of the message to be added
-        """
-
-        while 1:
-            try:
-                now = time.time()
-                self._messages[ now ] = message
-                transaction.commit()
-            except ConflictError:
-                # Conflict occurred; this process should pause and
-                # wait for a little bit, then try again.
-                time.sleep(.2)
-                pass
-            else:
-                # No ConflictError exception raised, so break
-                # out of the enclosing while loop.
-                break
-        # end while
-
-def get_chat_session(conn, channelname):
-    """Return the chat session for a given channel, creating the session
-    if required."""
-
-    # We'll keep a B-tree of sessions, mapping channel names to
-    # session objects.  The B-tree is stored at the ZODB's root under
-    # the key 'chat_sessions'.
-    root = conn.root()
-    if not root.has_key('chat_sessions'):
-        print 'Creating chat_sessions B-tree'
-        root['chat_sessions'] = OOBTree.OOBTree()
-        transaction.commit()
-
-    sessions = root['chat_sessions']
-
-    # Get a session object corresponding to the channel name, creating
-    # it if necessary.
-    if not sessions.has_key( channelname ):
-        print 'Creating new session:', channelname
-        sessions[ channelname ] = ChatSession(channelname)
-        transaction.commit()
-
-    session = sessions[ channelname ]
-    return session
-
-
-if __name__ == '__main__':
-    if len(sys.argv) != 2:
-        print 'Usage: %s <channelname>' % sys.argv[0]
-        sys.exit(0)
-
-    storage = ClientStorage.ClientStorage( ('localhost', 9672) )
-    db = ZODB.DB( storage )
-    conn = db.open()
-
-    s = session = get_chat_session(conn, sys.argv[1])
-
-    messages = ['Hi.', 'Hello', 'Me too', "I'M 3L33T!!!!"]
-
-    while 1:
-        # Send a random message
-        msg = random.choice(messages)
-        session.add_message( '%s: pid %i' % (msg,os.getpid() ))
-
-        # Display new messages
-        for msg in session.new_messages():
-            print msg
-
-        # Wait for a few seconds
-        pause = random.randint( 1, 4 )
-        time.sleep( pause )

tags/3.3b1/doc/guide/indexing.tex

-
-% Indexing Data
-%    BTrees
-%    Full-text indexing
-

tags/3.3b1/doc/guide/links.tex

-% links.tex
-% Collection of relevant links
-
-\section{Resources}
-
-Introduction to the Zope Object Database, by Jim Fulton:
-\\
-Goes into much greater detail, explaining advanced uses of the ZODB and 
-how it's actually implemented.  A definitive reference, and highly recommended.
-\\
-\url{http://www.python.org/workshops/2000-01/proceedings/papers/fulton/zodb3.html}
-
-Persistent Programing with ZODB, by Jeremy Hylton and Barry Warsaw:
-\\
-Slides for a tutorial presented at the 10th Python conference.  Covers
-much of the same ground as this guide, with more details in some areas
-and less in others.
-\\
-\url{http://www.zope.org/Members/bwarsaw/ipc10-slides}
-
-

tags/3.3b1/src/BTrees/DEPENDENCIES.cfg

-persistent
-transaction

tags/3.3b1/src/BTrees/tests/__init__.py

-# If tests is a package, debugging is a bit easier.

tags/3.3b1/src/Persistence/DEPENDENCIES.cfg

-ZODB
-persistent

tags/3.3b1/src/Persistence/tests/__init__.py

-# package