Merge branch '2.1'

Author: weaverryan

contributing/code/bugs.rst

@@ -25,7 +25,7 @@ If your problem definitely looks like a bug, report it using the official bug
 * Describe the steps needed to reproduce the bug with short code examples
   (providing a unit test that illustrates the bug is best);
 
-* Give as much details as possible about your environment (OS, PHP version,
+* Give as much detail as possible about your environment (OS, PHP version,
   Symfony version, enabled extensions, ...);
 
 * *(optional)* Attach a :doc:`patch <patches>`.

contributing/code/patches.rst

@@ -71,7 +71,7 @@ Get the Symfony2 source code:
 
 * Fork the `Symfony2 repository`_ (click on the "Fork" button);
 
-* After the "hardcore forking action" has completed, clone your fork locally
+* After the "forking action" has completed, clone your fork locally
   (this will create a `symfony` directory):
 
 .. code-block:: bash
@@ -251,8 +251,8 @@ You can now make a pull request on the ``symfony/symfony`` Github repository.
 
 .. tip::
 
-    Take care to point your pull request towards ``symfony:2.0`` if you want
-    the core team to pull a bugfix based on the 2.0 branch.
+    Take care to point your pull request towards ``symfony:2.1`` if you want
+    the core team to pull a bugfix based on the 2.1 branch.
 
 To ease the core team work, always include the modified components in your
 pull request message, like in:
@@ -267,6 +267,9 @@ pull request message, like in:
     Please use the title with "[WIP]" if the submission is not yet completed
     or the tests are incomplete or not yet passing.
 
+Pull Request Description
+~~~~~~~~~~~~~~~~~~~~~~~~
+
 The pull request description must include the following check list to ensure
 that contributions may be reviewed without needless feedback loops and that
 your contributions can be included into Symfony2 as quickly as possible:

contributing/code/security.rst

@@ -21,21 +21,23 @@ confirmed, the core-team works on a solution following these steps:
 
 1. Send an acknowledgement to the reporter;
 2. Work on a patch;
-3. Write a security announcement for the official Symfony `blog`_ about the
+3. Get a CVE identifier from mitre.org;
+4. Write a security announcement for the official Symfony `blog`_ about the
    vulnerability. This post should contain the following information:
 
    * a title that always include the "Security release" string;
    * a description of the vulnerability;
    * the affected versions;
    * the possible exploits;
    * how to patch/upgrade/workaround affected applications;
+   * the CVE identifier;
    * credits.
-4. Send the patch and the announcement to the reporter for review;
-5. Apply the patch to all maintained versions of Symfony;
-6. Package new versions for all affected versions;
-7. Publish the post on the official Symfony `blog`_ (it must also be added to
+5. Send the patch and the announcement to the reporter for review;
+6. Apply the patch to all maintained versions of Symfony;
+7. Package new versions for all affected versions;
+8. Publish the post on the official Symfony `blog`_ (it must also be added to
    the "`Security Advisories`_" category);
-8. Update the security advisory list (see below).
+9. Update the security advisory list (see below).
 
 .. note::
 
@@ -52,10 +54,11 @@ Security Advisories
 This section indexes security vulnerabilities that were fixed in Symfony
 releases, starting from Symfony 1.0.0:
 
+* December 20, 2012: `Security release: Symfony 2.0.20 and 2.1.5 <http://symfony.com/blog/security-release-symfony-2-0-20-and-2-1-5-released>`_  (`CVE-2012-6431 <http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2012-6431>`_ and `CVE-2012-6432 <http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2012-6432>`_)
 * November 29, 2012: `Security release: Symfony 2.0.19 and 2.1.4 <http://symfony.com/blog/security-release-symfony-2-0-19-and-2-1-4>`_
-* November 25, 2012: `Security release: symfony 1.4.20 released  <http://symfony.com/blog/security-release-symfony-1-4-20-released>`_
+* November 25, 2012: `Security release: symfony 1.4.20 released  <http://symfony.com/blog/security-release-symfony-1-4-20-released>`_ (`CVE-2012-5574 <http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2012-5574>`_)
 * August 28, 2012: `Security Release: Symfony 2.0.17 released <http://symfony.com/blog/security-release-symfony-2-0-17-released>`_
-* May 30, 2012: `Security Release: symfony 1.4.18 released <http://symfony.com/blog/security-release-symfony-1-4-18-released>`_
+* May 30, 2012: `Security Release: symfony 1.4.18 released <http://symfony.com/blog/security-release-symfony-1-4-18-released>`_ (`CVE-2012-2667 <http://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2012-2667>`_)
 * February 24, 2012: `Security Release: Symfony 2.0.11 released <http://symfony.com/blog/security-release-symfony-2-0-11-released>`_
 * November 16, 2011: `Security Release: Symfony 2.0.6 <http://symfony.com/blog/security-release-symfony-2-0-6>`_
 * March 21, 2011: `symfony 1.3.10 and 1.4.10: security releases <http://symfony.com/blog/symfony-1-3-10-and-1-4-10-security-releases>`_

contributing/code/standards.rst

@@ -15,7 +15,7 @@ documents.
 Since a picture - or some code - is worth a thousand words, here's a short
 example containing most features described below:
 
-.. code-block:: php
+.. code-block:: html+php
 
     <?php
 
@@ -40,7 +40,7 @@ example containing most features described below:
         private $fooBar;
 
         /**
-         * @param string $dummy Some argument description
+         * @param string $dummyy Some argument description
          */
         public function __construct($dummy)
         {
@@ -82,17 +82,17 @@ Structure
 
 * Add a single space after each comma delimiter;
 
-* Add a single space around operators (`==`, `&&`, ...);
+* Add a single space around operators (``==``, ``&&``, ...);
 
-* Add a blank line before `return` statements, unless the return is alone
-  inside a statement-group (like an `if` statement);
+* Add a blank line before ``return`` statements, unless the return is alone
+  inside a statement-group (like an ``if`` statement);
 
 * Use braces to indicate control structure body regardless of the number of
   statements it contains;
 
 * Define one class per file - this does not apply to private helper classes
   that are not intended to be instantiated from the outside and thus are not
-  concerned by the PSR-0 standard;
+  concerned by the `PSR-0`_ standard;
 
 * Declare class properties before methods;
 
@@ -108,9 +108,15 @@ Naming Conventions
 
 * Use namespaces for all classes;
 
-* Abstract classes are often prefixed with `Abstract`;
+* Prefix abstract classes with ``Abstract``. Please note some early Symfony2 classes
+  do not follow this convention and have not been renamed for backward compatibility
+  reasons. However all new abstract classes must follow this naming convention;
+
+* Suffix interfaces with ``Interface``;
+
+* Suffix traits with ``Trait``;
 
-* Suffix interfaces with `Interface`;
+* Suffix exceptions with ``Exception``;
 
 * Use alphanumeric characters and underscores for file names;
 
@@ -122,9 +128,9 @@ Documentation
 
 * Add PHPDoc blocks for all classes, methods, and functions;
 
-* Omit the `@return` tag if the method does not return anything;
+* Omit the ``@return`` tag if the method does not return anything;
 
-* The `@package` and `@subpackage` annotations are not used.
+* The ``@package`` and ``@subpackage`` annotations are not used.
 
 License
 -------

contributing/documentation/format.rst

@@ -108,10 +108,6 @@ The current list of supported formats are the following:
 +-----------------+-------------+
 | html+jinja      | Twig        |
 +-----------------+-------------+
-| jinja+html      | Twig        |
-+-----------------+-------------+
-| php+html        | PHP         |
-+-----------------+-------------+
 | html+php        | PHP         |
 +-----------------+-------------+
 | ini             | INI         |

cookbook/bundles/best_practices.rst

@@ -263,7 +263,7 @@ The end user can provide values in any configuration file:
 
     .. code-block:: ini
 
-        ; app/config/config.ini
+        ; app/config/parameters.ini
         [parameters]
         acme_hello.email.from = fabien@example.com
 

cookbook/configuration/external_parameters.rst

@@ -99,18 +99,18 @@ The container also has support for setting PHP constants as parameters. To
 take advantage of this feature, map the name of your constant  to a parameter
 key, and define the type as ``constant``.
 
-    .. code-block:: xml
+.. code-block:: xml
 
-        <?xml version="1.0" encoding="UTF-8"?>
+    <?xml version="1.0" encoding="UTF-8"?>
 
-        <container xmlns="http://symfony.com/schema/dic/services"
-            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+    <container xmlns="http://symfony.com/schema/dic/services"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 
-            <parameters>
-                <parameter key="global.constant.value" type="constant">GLOBAL_CONSTANT</parameter>
-                <parameter key="my_class.constant.value" type="constant">My_Class::CONSTANT_NAME</parameter>
-            </parameters>
-        </container>
+        <parameters>
+            <parameter key="global.constant.value" type="constant">GLOBAL_CONSTANT</parameter>
+            <parameter key="my_class.constant.value" type="constant">My_Class::CONSTANT_NAME</parameter>
+        </parameters>
+    </container>
 
 .. note::
 

cookbook/configuration/pdo_session_storage.rst

@@ -136,22 +136,22 @@ parameter.ini by referencing the database-related parameters defined there:
         pdo:
             class: PDO
             arguments:
-                - "mysql:dbname=%database_name%"
+                - "mysql:host=%database_host%;port=%database_port%;dbname=%database_name%"
                 - %database_user%
                 - %database_password%
 
     .. code-block:: xml
 
         <service id="pdo" class="PDO">
-            <argument>mysql:dbname=%database_name%</argument>
+            <argument>mysql:host=%database_host%;port=%database_port%;dbname=%database_name%</argument>
             <argument>%database_user%</argument>
             <argument>%database_password%</argument>
         </service>
 
     .. code-block:: php
 
         $pdoDefinition = new Definition('PDO', array(
-            'mysql:dbname=%database_name%',
+            'mysql:host=%database_host%;port=%database_port%;dbname=%database_name%',
             '%database_user%',
             '%database_password%',
         ));

cookbook/doctrine/file_uploads.rst

@@ -176,7 +176,7 @@ The following controller shows you how to handle the entire process::
 
     When writing the template, don't forget to set the ``enctype`` attribute:
 
-    .. code-block:: html+php
+    .. code-block:: html+jinja
 
         <h1>Upload File</h1>
 

cookbook/doctrine/registration_form.rst

@@ -151,6 +151,7 @@ Start by creating a simple class which represents the "registration"::
     {
         /**
          * @Assert\Type(type="Acme\AccountBundle\Entity\User")
+         * @Assert\Valid()
          */
         protected $user;
 

cookbook/form/form_collections.rst

@@ -425,7 +425,8 @@ into new ``Tag`` objects and added to the ``tags`` property of the ``Task`` obje
     and call ``$em->persist($tag)`` on each, you'll receive an error from
     Doctrine:
 
-        A new entity was found through the relationship 'Acme\TaskBundle\Entity\Task#tags' that was not configured to cascade persist operations for entity...
+        A new entity was found through the relationship `Acme\TaskBundle\Entity\Task#tags`
+        that was not configured to cascade persist operations for entity...
 
     To fix this, you may choose to "cascade" the persist operation automatically
     from the ``Task`` object to any related tags. To do this, add the ``cascade``

cookbook/map.rst.inc

@@ -41,7 +41,7 @@
 
 * **Deployment**
 
-* :doc:`/cookbook/deployment-tools`
+  * :doc:`/cookbook/deployment-tools`
 
 * :doc:`/cookbook/doctrine/index`
 

cookbook/security/entity_provider.rst

@@ -200,9 +200,9 @@ For more details on each of these, see :class:`Symfony\\Component\\Security\\Cor
 Below is an export of my ``User`` table from MySQL. For details on how to
 create user records and encode their password, see :ref:`book-security-encoding-user-password`.
 
-.. code-block:: text
+.. code-block:: bash
 
-    mysql> select * from user;
+    $ mysql> select * from user;
     +----+----------+----------------------------------+------------------------------------------+--------------------+-----------+
     | id | username | salt                             | password                                 | email              | is_active |
     +----+----------+----------------------------------+------------------------------------------+--------------------+-----------+

cookbook/symfony1.rst

@@ -90,9 +90,11 @@ a bundle. With the help of a console command, the ``Resources/public/``
 directory of each bundle is copied or symbolically-linked to the ``web/bundles/``
 directory. This allows you to keep assets organized inside your bundle, but
 still make them available to the public. To make sure that all bundles are
-available, run the following command::
+available, run the following command:
 
-    php app/console assets:install web
+.. code-block:: bash
+
+    $ php app/console assets:install web
 
 .. note::
 
@@ -174,16 +176,16 @@ Using the Console
 In symfony1, the console is in the root directory of your project and is
 called ``symfony``:
 
-.. code-block:: text
+.. code-block:: bash
 
-    php symfony
+    $ php symfony
 
 In Symfony2, the console is now in the app sub-directory and is called
 ``console``:
 
-.. code-block:: text
+.. code-block:: bash
 
-    php app/console
+    $ php app/console
 
 Applications
 ------------
@@ -251,7 +253,9 @@ In symfony1, the ``routing.yml`` and ``app.yml`` configuration files were
 automatically loaded inside any plugin. In Symfony2, routing and application
 configuration inside a bundle must be included manually. For example, to
 include a routing resource from a bundle called ``AcmeDemoBundle``, you can
-do the following::
+do the following:
+
+.. code-block:: yaml
 
     # app/config/routing.yml
     _hello:
@@ -301,4 +305,4 @@ primarily to configure objects that you can use. For more information, see
 the chapter titled ":doc:`/book/service_container`".
 
 .. _`Symfony2 Standard`: https://github.com/symfony/symfony-standard
-.. _`Composer`: http://getcomposer.org
+.. _`Composer`: http://getcomposer.org

cookbook/templating/global_variables.rst

@@ -24,10 +24,10 @@ Now, the variable ``ga_tracking`` is available in all Twig templates:
 It's that easy! You can also take advantage of the built-in :ref:`book-service-container-parameters`
 system, which lets you isolate or reuse the value:
 
-.. code-block:: ini
+.. code-block:: yaml
 
-    ; app/config/parameters.yml
-    [parameters]
+    # app/config/parameters.yml
+    parameters:
         ga_tracking: UA-xxxxx-x
 
 .. code-block:: yaml

cookbook/testing/bootstrap.rst

@@ -25,7 +25,12 @@ with ``tests.bootstrap.php``:
 .. code-block:: xml
 
     <!-- app/phpunit.xml.dist -->
-    bootstrap = "tests.bootstrap.php"
+
+    <!-- ... -->
+    <phpunit
+        ...
+        bootstrap = "tests.bootstrap.php"
+    >
 
 Now, you can define in your ``phpunit.xml.dist`` file which environment you want the
 cache to be cleared:

cookbook/workflow/_vendor_deps.rst.inc

@@ -22,6 +22,32 @@ allows you to pin each library to an **exact** version. In fact, if a ``composer
 file exists, the versions inside will override those in ``composer.json``.
 To upgrade your libraries to new versions, run ``php composer.phar update``.
 
+.. tip::
+
+    If you want to add a new package to your application, modify the ``composer.json``
+    file:
+
+    .. code-block:: json
+
+        {
+            "require": {
+                ...
+                "doctrine/doctrine-fixtures-bundle": "@dev"
+            }
+        }
+
+    and then execute the ``update`` command for this specific package, i.e.:
+
+    .. code-block:: bash
+
+        $ php composer.phar update doctrine/doctrine-fixtures-bundle
+
+    You can also combine both steps into a single command:
+
+    .. code-block:: bash
+
+        $ php composer.phar require doctrine/doctrine-fixtures-bundle:@dev
+
 To learn more about Composer, see `GetComposer.org`_:
 
 It's important to realize that these vendor libraries are *not* actually part

images/book/doctrine_image_1.png

@@ -2,8 +2,8 @@
    single: Doctrine; ORM configuration reference
    single: Configuration reference; Doctrine ORM
 
-Configuration Reference
-=======================
+Doctrine Configuration Reference
+================================
 
 .. configuration-block::