Repoze.catalog

==================

Features
--------

- Refuse to pickle instances of ``zodb.broken.Broken`` which are
returned as the result of an index attempting to call a callable
discriminator function. This prevents edge cases where instances
with out-of-sync code could too easily write Broken objects to the
database, leaving them around for the next hapless unpickler to
find. This is particularly a problem because many of our
discriminators are *functions*; the Broken machinery attempts to
recover the state of a broken object when it is unpickled, but it
cannot recover the state of an attempted function call.

==================

Bug Fixes
---------

- Fix a bug which allowed the document map to map more than one docid
onto the same address, which put the reverse and forward document
map bookeeping out of sync with each other.

Packaging
---------

- Move benchmark directory into root of distribution instead of
leaving it in package. It interfered with normal operations of the
setuptools testrunner.

- Deactivate "sortbench" console script.

- Remove "Development Status" Trove classifier.

- Bump version to 0.7.2.

- Disuse nose.collector as test_suite (use normal setuptools test runner).

- Remove (unused) TODO.txt.

- Disuse ez_setup.py.

- Make docs render properly in Google Chrome.

Backwards Incompatibilities
---------------------------

- When using ``DocumentMap.add`` with a ``docid`` argument that
references an existing docid with metadata, that metadata is now
removed. Previously it was retained.

==================

- Minimally get docs into shape for First PyPI release; no
functionality changes from 0.7.0.

==================

- Fixed bug in ``DocumentMap.add`` which left orphan mappings for previous
addresses when adding an existing docid with a new address.

- Added the ability to sort by text relevance. Use the name of the text
index as the ``sort_index`` in the query.

==================

- Add metadata-related APIs to ``repoze.catalog.document.DocumentMap``:
``add_metadata``, ``remove_metadata``, ``get_metadata``.
"Metadata" is a freeform set of key/value pairs related to a docid.
See the API documentation for more information.

==================

- Fixed constructor inheritance issues which kept ``repoze.catalog``
from working under Python 2.6. Note that this change involved removing
the ``*args, **kw`` arguments from index constructors: those values were
never used, but had (bogus) tests.