Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecation message in documentation for YAML #7374

Merged
merged 2 commits into from
Nov 10, 2018
Merged

Deprecation message in documentation for YAML #7374

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d36aec8
Add deprecation message for YAML into docs
SenseException Aug 25, 2018
ff1df41
Add deprecation note to getting-started chapter
SenseException Sep 7, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/en/reference/yaml-mapping.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
29 changes: 26 additions & 3 deletions docs/en/tutorials/getting-started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Majkl578 marked this conversation as resolved.
Show resolved Hide resolved
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
---------------------------

Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -308,6 +315,10 @@ but you only need to choose one.
</entity>
</doctrine-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.

.. code-block:: yaml

# config/yaml/Product.dcm.yml
Expand Down Expand Up @@ -851,6 +862,10 @@ the ``Product`` before:
</entity>
</doctrine-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.

.. code-block:: yaml

# config/yaml/Bug.dcm.yml
Expand Down Expand Up @@ -963,6 +978,10 @@ Finally, we'll add metadata mappings for the ``User`` entity.
</entity>
</doctrine-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.

.. code-block:: yaml

# config/yaml/User.dcm.yml
Expand Down Expand Up @@ -1493,6 +1512,10 @@ we have to adjust the metadata slightly.
</entity>
</doctrine-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.

.. code-block:: yaml

Bug:
Expand Down