[Checkins] SVN: z3c.autoinclude/branches/adding-salt/ rename
'autoinclude' directive to 'includeDependencies' to reduce ambiguity
Ethan Jucovy
ejucovy at openplans.org
Tue Mar 25 09:09:13 EDT 2008
Log message for revision 84929:
rename 'autoinclude' directive to 'includeDependencies' to reduce ambiguity
Changed:
U z3c.autoinclude/branches/adding-salt/README.txt
U z3c.autoinclude/branches/adding-salt/src/z3c/autoinclude/README.txt
U z3c.autoinclude/branches/adding-salt/src/z3c/autoinclude/meta.zcml
U z3c.autoinclude/branches/adding-salt/src/z3c/autoinclude/tests/APackage/a/configure.zcml
U z3c.autoinclude/branches/adding-salt/src/z3c/autoinclude/tests/BCPackage/b/c/configure.zcml
-=-
Modified: z3c.autoinclude/branches/adding-salt/README.txt
===================================================================
--- z3c.autoinclude/branches/adding-salt/README.txt 2008-03-25 12:46:05 UTC (rev 84928)
+++ z3c.autoinclude/branches/adding-salt/README.txt 2008-03-25 13:09:13 UTC (rev 84929)
@@ -1,12 +1,12 @@
-This package adds a new ZCML directive: "autoinclude". This directive
-searches through the dependencies in your setup.py file
+This package adds a new ZCML directive: "includeDependencies". This
+directive searches through the dependencies in your setup.py file
(install_requires), and includes the meta.zcml and configure.zcml
files in those packages that it finds. Inclusion order matches the
order in the setup.py file. You can pass a path for the package you
-want to autoinclude for, but typically you pass in the current
-package, as follows::
+want to include dependencies for, but typically you pass in the
+current package, as follows::
- <autoinclude package="." />
+ <includeDependencies package="." />
The motivation behind this is to prevent having to repeat yourself in
two places when you want to depend on a Zope 3 or Grok-based
@@ -21,19 +21,19 @@
The next versions of Grok_ and grokproject_ will use this functionality
out of the box. The grokproject command will automatically add the
-``autoinclude`` directive in the ZCML of the project it generates. You
-can then stop worrying about manual ZCML inclusion in the vast
+``includeDependencies`` directive in the ZCML of the project it generates.
+You can then stop worrying about manual ZCML inclusion in the vast
majority of cases.
-The ``autoinclude`` directive automatically includes
+The ``includeDependencies`` directive automatically includes
``configure.zcml`` and ``meta.zcml`` files that in the main package
directories. In some cases, a package may use unusual names or
locations for its ZCML files. In that case you will need to modify
your package's ``configure.zcml`` and ``meta.zcml`` yourself to
include the ZCML using the manual ``include`` directive.
-To make the ``autoinclude`` directive available for use in your
-application or framework, you need to include it (in your
+To make the ``includeDependencies`` directive available for use in
+your application or framework, you need to include it (in your
``meta.zcml`` for instance), like this::
<include package="z3c.autoinclude" file="meta.zcml" />
Modified: z3c.autoinclude/branches/adding-salt/src/z3c/autoinclude/README.txt
===================================================================
--- z3c.autoinclude/branches/adding-salt/src/z3c/autoinclude/README.txt 2008-03-25 12:46:05 UTC (rev 84928)
+++ z3c.autoinclude/branches/adding-salt/src/z3c/autoinclude/README.txt 2008-03-25 13:09:13 UTC (rev 84929)
@@ -12,7 +12,7 @@
To trigger autoinclusion of a package's dependencies, include the
following directive::
- <autoinclude package='.' />
+ <includeDependencies package='.' />
To trigger autoinclusion of a package's extensions, include the
following directive::
Modified: z3c.autoinclude/branches/adding-salt/src/z3c/autoinclude/meta.zcml
===================================================================
--- z3c.autoinclude/branches/adding-salt/src/z3c/autoinclude/meta.zcml 2008-03-25 12:46:05 UTC (rev 84928)
+++ z3c.autoinclude/branches/adding-salt/src/z3c/autoinclude/meta.zcml 2008-03-25 13:09:13 UTC (rev 84929)
@@ -4,12 +4,12 @@
<meta:directives namespace="http://namespaces.zope.org/zope">
<meta:directive
- name="autoinclude"
+ name="includeDependencies"
schema=".zcml.IAutoIncludeDirective"
handler=".zcml.autoIncludeDirective"
/>
<meta:directive
- name="autoincludeOverrides"
+ name="includeDependenciesOverrides"
schema=".zcml.IAutoIncludeDirective"
handler=".zcml.autoIncludeOverridesDirective"
/>
Modified: z3c.autoinclude/branches/adding-salt/src/z3c/autoinclude/tests/APackage/a/configure.zcml
===================================================================
--- z3c.autoinclude/branches/adding-salt/src/z3c/autoinclude/tests/APackage/a/configure.zcml 2008-03-25 12:46:05 UTC (rev 84928)
+++ z3c.autoinclude/branches/adding-salt/src/z3c/autoinclude/tests/APackage/a/configure.zcml 2008-03-25 13:09:13 UTC (rev 84929)
@@ -1,6 +1,6 @@
<configure xmlns="http://namespaces.zope.org/zope">
<include package="z3c.autoinclude" file="meta.zcml" />
- <autoinclude package="." />
+ <includeDependencies package="." />
<!-- APackage is autoincluded.
This means that BCPackage and TestDirective will be included, in no particular order.
TestDirective has a meta.zcml.
Modified: z3c.autoinclude/branches/adding-salt/src/z3c/autoinclude/tests/BCPackage/b/c/configure.zcml
===================================================================
--- z3c.autoinclude/branches/adding-salt/src/z3c/autoinclude/tests/BCPackage/b/c/configure.zcml 2008-03-25 12:46:05 UTC (rev 84928)
+++ z3c.autoinclude/branches/adding-salt/src/z3c/autoinclude/tests/BCPackage/b/c/configure.zcml 2008-03-25 13:09:13 UTC (rev 84929)
@@ -1,6 +1,6 @@
<configure xmlns="http://namespaces.zope.org/zope">
<include package="z3c.autoinclude" file="meta.zcml" />
- <autoinclude package="." />
+ <includeDependencies package="." />
<test test_string="BCPackage has been loaded" />
<!-- BCPackage is autoincluded.
This means that SiblingPackage and TestDirective will be included, in no particular order.
More information about the Checkins
mailing list