summaryrefslogtreecommitdiff
path: root/docs/narr/security.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/narr/security.rst')
-rw-r--r--docs/narr/security.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/narr/security.rst b/docs/narr/security.rst
index 91c7240dc..590b90b2e 100644
--- a/docs/narr/security.rst
+++ b/docs/narr/security.rst
@@ -179,6 +179,18 @@ during traversal in a *location proxy* that has both the ``__name__``
and ``__parent__`` attributes, but otherwise acts the same as your
model object.
+.. note::
+ In order to use this feature, you must register the
+ ``WrappingModelGraphTraverser`` as the traversal policy, rather
+ than the standard ``ModelGraphTraverser``. E.g., your application
+ will need to have the following in its ``configure.zcml``::
+
+ <adapter
+ factory="repoze.bfg.traversal.WrappingModelGraphTraverser"
+ provides="repoze.bfg.interfaces.ITraverserFactory"
+ for="*"
+ />
+
You can of course supply ``__name__`` and ``__parent__`` attributes
explicitly on all of your model objects, and no location proxying will
be performed.