From d36aec8fb7f0ee9031364fdf753cbb7dc9d0f7a9 Mon Sep 17 00:00:00 2001 From: Claudio Zizza Date: Sun, 26 Aug 2018 00:31:55 +0200 Subject: [PATCH 1/2] Add deprecation message for YAML into docs --- docs/en/reference/yaml-mapping.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/en/reference/yaml-mapping.rst b/docs/en/reference/yaml-mapping.rst index ea54e277a..8199406eb 100644 --- a/docs/en/reference/yaml-mapping.rst +++ b/docs/en/reference/yaml-mapping.rst @@ -1,6 +1,10 @@ YAML Mapping ============ +.. note:: + The YAML driver is deprecated and will be removed in version 3.0. + It is strongly recommended to switch to one of the other mappings. + The YAML mapping driver enables you to provide the ORM metadata in form of YAML documents. From ff1df41485427645aadf200711b1263140a616fb Mon Sep 17 00:00:00 2001 From: Claudio Zizza Date: Fri, 7 Sep 2018 21:06:08 +0200 Subject: [PATCH 2/2] Add deprecation note to getting-started chapter --- docs/en/tutorials/getting-started.rst | 29 ++++++++++++++++++++++++--- 1 file changed, 26 insertions(+), 3 deletions(-) diff --git a/docs/en/tutorials/getting-started.rst b/docs/en/tutorials/getting-started.rst index 605b1a017..e8dde41af 100644 --- a/docs/en/tutorials/getting-started.rst +++ b/docs/en/tutorials/getting-started.rst @@ -103,18 +103,21 @@ Install Doctrine using the Composer Dependency Management tool, by calling: $ composer install This will install the packages Doctrine Common, Doctrine DBAL, Doctrine ORM, -Symfony YAML and Symfony Console into the `vendor` directory. The Symfony -dependencies are not required by Doctrine but will be used in this tutorial. +into the `vendor` directory. Add the following directories: :: doctrine2-tutorial |-- config - | |-- xml + | `-- xml | `-- yaml `-- src +.. note:: + The YAML driver is deprecated and will be removed in version 3.0. + It is strongly recommended to switch to one of the other mappings. + Obtaining the EntityManager --------------------------- @@ -150,6 +153,10 @@ step: // obtaining the entity manager $entityManager = EntityManager::create($conn, $config); +.. note:: + The YAML driver is deprecated and will be removed in version 3.0. + It is strongly recommended to switch to one of the other mappings. + The require_once statement sets up the class autoloading for Doctrine and its dependencies using Composer's autoloader. @@ -308,6 +315,10 @@ but you only need to choose one. +.. note:: + The YAML driver is deprecated and will be removed in version 3.0. + It is strongly recommended to switch to one of the other mappings. + .. code-block:: yaml # config/yaml/Product.dcm.yml @@ -851,6 +862,10 @@ the ``Product`` before: +.. note:: + The YAML driver is deprecated and will be removed in version 3.0. + It is strongly recommended to switch to one of the other mappings. + .. code-block:: yaml # config/yaml/Bug.dcm.yml @@ -963,6 +978,10 @@ Finally, we'll add metadata mappings for the ``User`` entity. +.. note:: + The YAML driver is deprecated and will be removed in version 3.0. + It is strongly recommended to switch to one of the other mappings. + .. code-block:: yaml # config/yaml/User.dcm.yml @@ -1493,6 +1512,10 @@ we have to adjust the metadata slightly. +.. note:: + The YAML driver is deprecated and will be removed in version 3.0. + It is strongly recommended to switch to one of the other mappings. + .. code-block:: yaml Bug: