[Zope-Checkins] SVN: Zope/trunk/ - LP #143144: Fix documentation for the zope.conf ``mount-point``

[Jens Vagelpohl]

Log message for revision 112554:
  - LP #143144: Fix documentation for the zope.conf ``mount-point``
    directive.
  

Changed:
  U   Zope/trunk/doc/CHANGES.rst
  U   Zope/trunk/src/Zope2/Startup/zopeschema.xml

-=-
Modified: Zope/trunk/doc/CHANGES.rst
===================================================================
--- Zope/trunk/doc/CHANGES.rst	2010-05-19 18:14:23 UTC (rev 112553)
+++ Zope/trunk/doc/CHANGES.rst	2010-05-19 18:14:30 UTC (rev 112554)
@@ -162,6 +162,9 @@
 Bugs Fixed
 ++++++++++
 
+- LP #143144: Fix documentation for the zope.conf ``mount-point``
+  directive.
+
 - LP #142410: Do not index documents in a KeywordIndex if the document 
   is missing the indexed attribute, if determining the value raises 
   AttributeError, or of the indexed attribute is empty.

Modified: Zope/trunk/src/Zope2/Startup/zopeschema.xml
===================================================================
--- Zope/trunk/src/Zope2/Startup/zopeschema.xml	2010-05-19 18:14:23 UTC (rev 112553)
+++ Zope/trunk/src/Zope2/Startup/zopeschema.xml	2010-05-19 18:14:30 UTC (rev 112554)
@@ -212,10 +212,23 @@
     <multikey name="mount-point" required="yes" attribute="mount_points"
               datatype=".mount_point">
       <description>
-       The mount point is the slash-separated path to which this database
-       will be mounted within the Zope application server. If the path
-       on the ZEO server is different from the path of the mount point then
-       you can use a notation "path_on_client:path_on_zeo_server".
+       The mount point is a slash-separated path to a 
+       'Products.ZODBMountPoint.Mount.MountPoint' instance in Zope. If 
+       such an instance exists, it can mount an object (the mounted 
+       object) into Zope.
+       By default, the object will be mounted at the same path in Zope (i.e.
+       '/foo/bar' in the database will be mounted at '/foo/bar' in Zope).
+
+       The object can be mounted at a different point using the
+       'virtual_path:real_path' syntax (e.g.  'mount-point /foo/bar:/bar' 
+       will mount the object at '/bar' in the database to '/foo/bar' in 
+       Zope). The name of the mount point ('bar') must be the same as 
+       the mounted object.
+
+       It is also possible to specify the root that should be used in the
+       mounted database by using the syntax
+       'virtual_path:~real_root:real_path'. The root defaults to 'Application'
+       and should not normally be changed.
       </description>
     </multikey>