minor #9783 Documented the new Dump Server (javiereguiluz)

javiereguiluz · javiereguiluz · commit 3cd9ccd4bd03 · 2018-05-17T15:09:51.000+02:00
This PR was squashed before being merged into the 4.1 branch (closes #9783). Discussion ---------- Documented the new Dump Server This fixes #9474. Commits ------- 3eb53d3 Documented the new Dump Server
diff --git a/components/var_dumper.rst b/components/var_dumper.rst
@@ -91,6 +91,34 @@ current PHP SAPI:
     .. versionadded:: 4.1
         The ``dd()`` helper method was introduced in Symfony 4.1.
 
+The Dump Server
+---------------
+
+.. versionadded:: 4.1
+    The dump server was introduced in Symfony 4.1.
+
+The ``dump()`` function outputs its contents in the same browser window or
+console terminal as your own application. Sometimes mixing the real output
+with the debug output can be confusing. That's why this component provides a
+server to collect all the dumped data.
+
+Start the server with the ``server:dump`` command and whenever you call to
+``dump()``, the dumped data won't be displayed in the output but sent to that
+server, which outputs it to its own console or to an HTML file:
+
+.. code-block:: terminal
+
+    # displays the dumped data in the console:
+    $ ./bin/console server:dump
+      [OK] Server listening on tcp://0.0.0.0:9912
+
+    # stores the dumped data in a file using the HTML format:
+    $ ./bin/console server:dump --format=html > dump.html
+
+Inside a Symfony application, the output of the dump server is configured with
+the :ref:`dump_destination option <configuration-debug-dump_destination>` of the
+``debug`` package.
+
 DebugBundle and Twig Integration
 --------------------------------
 
diff --git a/reference/configuration/debug.rst b/reference/configuration/debug.rst
@@ -49,6 +49,8 @@ max_string_length
 This option configures the maximum string length before truncating the
 string. The default value (``-1``) means that strings are never truncated.
 
+.. _configuration-debug-dump_destination:
+
 dump_destination
 ~~~~~~~~~~~~~~~~
 
