diff options
Diffstat (limited to 'docs/zcml/scan.rst')
| -rw-r--r-- | docs/zcml/scan.rst | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/zcml/scan.rst b/docs/zcml/scan.rst new file mode 100644 index 000000000..d48cf66b4 --- /dev/null +++ b/docs/zcml/scan.rst @@ -0,0 +1,35 @@ +.. _scan_directive: + +``scan`` +-------- + +To make use of :term:`configuration decoration` decorators, you must +perform a :term:`scan`. A scan finds these decorators in code. The +``scan`` ZCML directive tells :mod:`repoze.bfg` to begin such a scan. + +Attributes +~~~~~~~~~~ + +``package`` + + The package to scan or the single dot (``.``), meaning the + "current" package (the package in which the ZCML file lives). + +Example +~~~~~~~ + +.. code-block:: xml + :linenos: + + <scan package="."/> + +Alternatives +~~~~~~~~~~~~ + +The :meth:`repoze.bfg.configuration.Configurator.scan` method performs +the same job as the ``scan`` ZCML directive. + +See Also +~~~~~~~~ + +See also :ref:`mapping_views_using_a_decorator_section`. |
