[Checkins] SVN: grok/trunk/ Update documentation on autoinclude.

Martijn Faassen faassen at infrae.com
Mon Feb 25 13:53:41 EST 2008


Log message for revision 84235:
  Update documentation on autoinclude.
  

Changed:
  U   grok/trunk/CHANGES.txt
  U   grok/trunk/doc/upgrade.txt

-=-
Modified: grok/trunk/CHANGES.txt
===================================================================
--- grok/trunk/CHANGES.txt	2008-02-25 18:45:43 UTC (rev 84234)
+++ grok/trunk/CHANGES.txt	2008-02-25 18:53:40 UTC (rev 84235)
@@ -15,7 +15,21 @@
   use it for the viewlets support. Note that this means Grok now
   requires Martian 0.9.3 or higher. See ``grok.interfaces`` for more
   documentation on this directive.
+
+* Now depend on ``z3c.autoinclude``. This allows the use of the
+  ``<autoinclude package="."/>`` directive, which automatically loads
+  up ZCML needed for the dependencies listed in your project's
+  ``setup.py``. The new release of grokproject adds this line
+  automatically. Upgrade ``grokproject`` to make use of this
+  functionality in new projects::
+
+    $ easy_install -U grokproject
+
+  See also the ``upgrade notes``_ for information on how to update
+  your existing projects.
  
+.. _``upgrade notes``: http://grok.zope.org/project/upgrade-notes
+
 Bug fixes
 ---------
 

Modified: grok/trunk/doc/upgrade.txt
===================================================================
--- grok/trunk/doc/upgrade.txt	2008-02-25 18:45:43 UTC (rev 84234)
+++ grok/trunk/doc/upgrade.txt	2008-02-25 18:53:40 UTC (rev 84235)
@@ -6,7 +6,26 @@
 describes changes involving incompatibilities or deprecations, not new
 features (please refer to ``CHANGES.txt`` for those).
 
+Upgrading to 0.12
+-----------------
 
+* If you have existing Grok projects and you want to make use of 
+  Grok's new autoinclusion functionality in them, you can place
+  the following line in your project's ``configure.zcml``:
+
+    <autoinclude package="." />
+
+  This will cause the ZCML for ``setup.py`` dependencies of your
+  package to be loaded automatically. You can now get rid of any
+  manual ``include`` statements (except the one that includes ``grok``
+  itself).
+
+  For new projects created by ``grokproject``, this line will be
+  automatically be added for you and you don't have to do anything except
+  to upgrade ``grokproject``::
+
+    $ easy_install -U grokproject
+
 Upgrading to 0.11
 -----------------
 



More information about the Checkins mailing list