From d19f25c1480c7732652006c9bdaa7faa30b2def4 Mon Sep 17 00:00:00 2001 From: Jules Pietri Date: Fri, 11 Aug 2023 15:17:05 +0200 Subject: [PATCH] [Console] Add `ProcessHelper` link to the list of helpers --- components/console/helpers/processhelper.rst | 9 +++++---- console.rst | 1 + 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/components/console/helpers/processhelper.rst b/components/console/helpers/processhelper.rst index ef462cef731..e3f1c8a09d2 100644 --- a/components/console/helpers/processhelper.rst +++ b/components/console/helpers/processhelper.rst @@ -1,11 +1,12 @@ Process Helper ============== -The Process Helper shows processes as they're running and reports -useful information about process status. +The Process Helper shows processes as they're running and reports useful +information about process status. -To display process details, use the :class:`Symfony\\Component\\Console\\Helper\\ProcessHelper` -and run your command with verbosity. For example, running the following code with +To display process details, use the +:class:`Symfony\\Component\\Console\\Helper\\ProcessHelper` and run your command +with verbosity. For example, running the following code with a very verbose verbosity (e.g. ``-vv``):: use Symfony\Component\Process\Process; diff --git a/console.rst b/console.rst index 28b560d1f9b..ee4f5db48e7 100644 --- a/console.rst +++ b/console.rst @@ -593,6 +593,7 @@ tools capable of helping you with different tasks: * :doc:`/components/console/helpers/table`: displays tabular data as a table * :doc:`/components/console/helpers/debug_formatter`: provides functions to output debug information when running an external program +* :doc:`/components/console/helpers/processhelper`: allows to run processes using ``DebugProcessHelper`` * :doc:`/components/console/helpers/cursor`: allows to manipulate the cursor in the terminal .. _`exit status`: https://en.wikipedia.org/wiki/Exit_status