Skip to content

[Console] Add ProcessHelper link to the list of helpers #18739

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions components/console/helpers/processhelper.rst
Original file line number Diff line number Diff line change
@@ -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;
Expand Down
1 change: 1 addition & 0 deletions console.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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