feature symfony#5310 Fix missing note about debug.dump_destination (nicolas-grekas)

wouterj · wouterj · commit 149576e043a8 · 2015-07-29T17:09:46.000+02:00
This PR was merged into the 2.6 branch. Discussion ---------- Fix missing note about debug.dump_destination | Q | A | ------------- | --- | Doc fix? | yes | New docs? | yes | Applies to | all | Fixed tickets | symfony#5275 Commits ------- dae2811 Fix missing note about debug.dump_destination
diff --git a/components/var_dumper/introduction.rst b/components/var_dumper/introduction.rst
@@ -104,13 +104,19 @@ original value. You can configure the limits in terms of:
 * maximum number of items to dump,
 * maximum string length before truncation.
 
+Since dumping into the toolbar is not always possible - e.g. when working on a
+JSON API - you can have an alternate output destination for dumps. This is
+configurable with the ``debug.dump_destination`` option, that you can typically
+set to ``php://stderr``.
+
 .. configuration-block::
 
     .. code-block:: yaml
 
         debug:
            max_items: 250
            max_string_length: -1
+           dump_destination: ~
 
     .. code-block:: xml
 
@@ -119,9 +125,17 @@ original value. You can configure the limits in terms of:
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://symfony.com/schema/dic/debug http://symfony.com/schema/dic/debug/debug-1.0.xsd">
 
-            <config max-items="250" max-string-length="-1" />
+            <config max-items="250" max-string-length="-1" dump-destination="null" />
         </container>
 
+    .. code-block:: php
+
+        $container->loadFromExtension('debug', array(
+           'max_items' => 250,
+           'max_string_length' => -1,
+           'dump_destination' => null,
+        ));
+
 Dump Examples and Output
 ------------------------
 
