Merge pull request #128 from symfony-cmf/jackalope-requirements

document jackalope requirements

Author: dbu

bundles/phpcr-odm.rst

@@ -22,8 +22,8 @@ Out of the box, this bundle supports the following PHPCR implementations:
 This bundle is based on the AbstractDoctrineBundle and thus is similar to the
 configuration of the Doctrine ORM and MongoDB bundles.
 
-Setup
------
+Setup and Requirements
+----------------------
 
 See :doc:`../tutorials/installing-configuring-doctrine-phpcr-odm`
 

cookbook/installing-cmf-sandbox.rst

@@ -15,17 +15,15 @@ setup, please refer to:
 
 .. index:: sandbox, install
 
-Preconditions
--------------
+Requirements
+------------
 
 As Symfony CMF Sandbox is based on Symfony2, you should make sure you
 meet the `Requirements for running Symfony2 <http://symfony.com/doc/current/reference/requirements.html>`_.
 `Git 1.6+ <http://git-scm.com/>`_, `Curl <http://curl.haxx.se/>`_ and PHP Intl are
 also needed to follow the installation steps listed below.
 
-If you wish to use Jackalope + Apache JackRabbit as the storage medium (recommended),
-you will also need Java (JRE). For other mechanisms and its requirements,
-please refer to their respective sections.
+For the PHPCR repository requirements, see :ref:`PHPCR-ODM requirements <tutorials-phpcr-odm-requirements>`
 
 Installation
 ------------

tutorials/installing-configuring-doctrine-phpcr-odm.rst

@@ -22,12 +22,19 @@ Finally for information about PHPCR see the `official PHPCR website <http://phpc
 
 .. index:: PHPCR, ODM
 
-Preconditions
--------------
-- php >= 5.3
-- libxml version >= 2.7.0 (due to a bug in libxml http://bugs.php.net/bug.php?id=36501)
-- phpunit >= 3.6 (if you want to run the tests)
-- Symfony2 (version 2.1.x)
+
+.. _tutorial-phpcr-odm-requirements:
+
+Requirements
+------------
+
+* Symfony2 (version 2.1 or newer)
+* phpunit >= 3.6 (if you want to run the tests)
+* When using **jackalope-jackrabbit**: Java, Apache Jackalope and libxml
+  version >= 2.7.0 (due to a `bug in libxml`_)
+* When using **jackalope-doctrine-dbal with MySQL**: MySQL >= 5.1.5
+  (as you need the xml function ``ExtractValue``)
+
 
 Installation
 ------------
@@ -356,3 +363,5 @@ The bundle provides a ``ValidPhpcrOdm`` constraint validator you can use to chec
         protected $parent;
 
         ...
+
+.. _`bug in libxml`: http://bugs.php.net/bug.php?id=36501)