minor #9700 Add best practice note about version (arderyp, javiereguiluz)

javiereguiluz · javiereguiluz · commit 35e4224b4b1c · 2018-05-16T15:48:41.000+02:00
This PR was submitted for the 4.0 branch but it was merged into the 2.7 branch instead (closes #9700). Discussion ---------- Add best practice note about version Adding this info based on request by @nicolas-grekas in [#27037](symfony/symfony#27037)  Commits ------- 6082b97 Minor tweak 9ecff4b components/phpunit_bridge.rst cd7fd94 Add best practice note about version
diff --git a/components/phpunit_bridge.rst b/components/phpunit_bridge.rst
@@ -27,12 +27,38 @@ Installation
 
 .. code-block:: terminal
 
-    $ composer require symfony/phpunit-bridge
+    $ composer require --dev "symfony/phpunit-bridge:*"
 
 Alternatively, you can clone the `<https://github.com/symfony/phpunit-bridge>`_ repository.
 
 .. include:: /components/require_autoload.rst.inc
 
+.. note::
+
+    The PHPUnit bridge is designed to work with all maintained versions of
+    Symfony components, even across different major versions of them. You should
+    always use its very latest stable major version to get the most accurate
+    deprecation report.
+
+If you plan to :ref:`write-assertions-about-deprecations` and use the regular
+PHPUnit script (not the modified PHPUnit script provided by Symfony), you have
+to register a new `test listener`_ called ``SymfonyTestsListener``:
+
+.. code-block:: xml
+
+    <!-- http://phpunit.de/manual/6.0/en/appendixes.configuration.html -->
+    <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+             xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/6.0/phpunit.xsd"
+    >
+
+        <!-- ... -->
+
+        <listeners>
+            <listener class="Symfony\Bridge\PhpUnit\SymfonyTestsListener" />
+        </listeners>
+    </phpunit>
+>>>>>>> Minor tweak
+
 Usage
 -----
 
