From 9c0d01bfa45c48531af57ba71d0e6dbac7a2043a Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Fri, 1 May 2009 07:01:14 +0000 Subject: Note new index location for BFG. --- CHANGES.txt | 89 +++++++++++++++++++++++++++++---------------------- docs/narr/install.rst | 8 ++--- 2 files changed, 55 insertions(+), 42 deletions(-) diff --git a/CHANGES.txt b/CHANGES.txt index 17e75f66f..4311827ad 100644 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -1,43 +1,17 @@ -Next release -============ - -Backwards Incompatibilities ---------------------------- - -- In all previous releases, by default, if the root object supplied - the``repoze.bfg.interfaces.ILocation`` interface, but the children - returned via its ``__getitem__`` did not return objects that - implemented the same interface, :mod:`repoze.bfg` provided some - implicit help during traversal. This traversal feature wrapped - subobjects from the root that did not implement ``ILocation`` in - proxies which automatically provided them with a ``__name__`` and - ``__parent__`` attribute based on the name being traversed and the - previous object traversed. This feature has now been disabled in - the default configuration for purposes of speed and - understandability. - - In order to re-enable the ILocation wrapper behavior for older - applications which cannot be changed, register the - ``WrappingModelGraphTraverser`` as the traversal policy, rather than - the default ``ModelGraphTraverser``. To use this feature, your - application will need to have the following in its - ``configure.zcml``:: - - +0.7.1 (2009-05-01) +================== - When this ITraverserFactory is used, no object in the graph (even - the root object) must supply a ``__name__`` or ``__parent__`` - attribute. Even if subobjects returned from the root *do* - implement the ILocation interface, these will still be wrapped in - proxies that override the object's "real" ``__parent__`` and - ``__name__`` attributes. +Index-Related +------------- - See also changes to the "Models" chapter of the documentation (in - the "Location-Aware Model Instances") section. +- The canonical package index location for ``repoze.bfg`` has changed. + The "old" index (http://dist.repoze.org/lemonade/dev/simple) has + been superseded by a new index location + (`http://dist.repoze.org/bfg/current/simple + `_). The installation + documentation has been updated. The "lemonade" index still exists, + but it is not guaranteed to have the latest BFG software in it, nor + will it be maintained in the future. Features -------- @@ -101,6 +75,45 @@ Features - Speed up / clarify 'traversal' module's 'model_path', 'model_path_tuple', and '_model_path_list' functions. +Backwards Incompatibilities +--------------------------- + +- In all previous releases, by default, if traversal was used (as + opposed to URL-dispatch), and the root object supplied + the``repoze.bfg.interfaces.ILocation`` interface, but the children + returned via its ``__getitem__`` returned an object that did not + implement the same interface, :mod:`repoze.bfg` provided some + implicit help during traversal. This traversal feature wrapped + subobjects from the root (and thereafter) that did not implement + ``ILocation`` in proxies which automatically provided them with a + ``__name__`` and ``__parent__`` attribute based on the name being + traversed and the previous object traversed. This feature has now + been disabled in the default configuration for purposes of speed and + understandability. + + In order to re-enable the ILocation wrapper behavior for older + applications which cannot be changed, register the + ``WrappingModelGraphTraverser`` as the traversal policy, rather than + the default ``ModelGraphTraverser``. To use this feature, your + application will need to have the following in its + ``configure.zcml``:: + + + + When this ITraverserFactory is used, no object in the graph (even + the root object) must supply a ``__name__`` or ``__parent__`` + attribute. Even if subobjects returned from the root *do* + implement the ILocation interface, these will still be wrapped in + proxies that override the object's "real" ``__parent__`` and + ``__name__`` attributes. + + See also changes to the "Models" chapter of the documentation (in + the "Location-Aware Model Instances") section. + 0.7.0 (2009-04-11) ================== diff --git a/docs/narr/install.rst b/docs/narr/install.rst index c9452c597..8eb0ae978 100644 --- a/docs/narr/install.rst +++ b/docs/narr/install.rst @@ -138,12 +138,12 @@ virtualenv (``bfgenv``) directory: .. code-block:: bash :linenos: - $ bin/easy_install -i http://dist.repoze.org/lemonade/dev/simple repoze.bfg + $ bin/easy_install -i http://dist.repoze.org/bfg/current/simple repoze.bfg .. warning:: Note carefully the ``-i - http://dist.repoze.org/lemonade/dev/simple`` above. It is - required. :mod:`repoze.bfg` software is maintained in its own - index; :mod:`repoze.bfg` cannot be installed from PyPI. + http://dist.repoze.org/bfg/current/simple`` above. It is required. + :mod:`repoze.bfg` software is maintained in its own index; + :mod:`repoze.bfg` cannot be installed from PyPI. This command will take longer than the previous ones to complete, as it compiles a number of dependencies. -- cgit v1.2.3