Skip to content
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

Improved the explanation about the verbosity levels of the console #5442

Merged
merged 4 commits into from
Jul 16, 2015
Merged
Changes from 2 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
26 changes: 11 additions & 15 deletions components/console/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -173,22 +173,18 @@ Verbosity Levels
The ``VERBOSITY_VERY_VERBOSE`` and ``VERBOSITY_DEBUG`` constants were introduced
in version 2.3

The console has 5 levels of verbosity. These are defined in the
The console has five verbosity levels. These are defined in the
:class:`Symfony\\Component\\Console\\Output\\OutputInterface`:

======================================= ==================================
Mode Value
======================================= ==================================
OutputInterface::VERBOSITY_QUIET Do not output any messages
OutputInterface::VERBOSITY_NORMAL The default verbosity level
OutputInterface::VERBOSITY_VERBOSE Increased verbosity of messages
OutputInterface::VERBOSITY_VERY_VERBOSE Informative non essential messages
OutputInterface::VERBOSITY_DEBUG Debug messages
======================================= ==================================

You can specify the quiet verbosity level with the ``--quiet`` or ``-q``
option. The ``--verbose`` or ``-v`` option is used when you want an increased
level of verbosity.
=========================================== ================================== =====================
Value Meaning Console option
=========================================== ================================== =====================
``OutputInterface::VERBOSITY_QUIET`` Do not output any messages ``-q`` or ``--quiet``
``OutputInterface::VERBOSITY_NORMAL`` The default verbosity level (none)
``OutputInterface::VERBOSITY_VERBOSE`` Increased verbosity of messages ``-v``
``OutputInterface::VERBOSITY_VERY_VERBOSE`` Informative non essential messages ``-vv``
``OutputInterface::VERBOSITY_DEBUG`` Debug messages ``-vvv``
=========================================== ================================== ======================
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there's an additional =


.. tip::

Expand All @@ -198,7 +194,7 @@ level of verbosity.
It is possible to print a message in a command for only a specific verbosity
level. For example::

if (OutputInterface::VERBOSITY_VERBOSE <= $output->getVerbosity()) {
if ($output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is already done in #5381

$output->writeln(...);
}

Expand Down