Skip to content

Commit

Permalink
minor #4644 Docs: add info about "-vv..." (voku)
Browse files Browse the repository at this point in the history
This PR was submitted for the master branch but it was merged into the 2.15 branch instead (closes #4644).

Discussion
----------

Docs: add info about "-vv..."

<!-- Reviewable:start -->
This change is [<img src="https://reviewable.io/review_button.svg" height="34" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/friendsofphp/php-cs-fixer/4644)
<!-- Reviewable:end -->

Commits
-------

2d7c0ee Docs: add info about \"-vv...\"
  • Loading branch information
keradus committed Mar 2, 2020
2 parents 579dfe2 + 2d7c0ee commit f9fd467
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -166,9 +166,17 @@ NOTE: the output for the following formats are generated in accordance with XML
* ``junit`` follows the `JUnit xml schema from Jenkins </doc/junit-10.xsd>`_
* ``checkstyle`` follows the common `"checkstyle" xml schema </doc/checkstyle.xsd>`_

The ``--quiet`` Do not output any message.

The ``--verbose`` option will show the applied rules. When using the ``txt`` format it will also display progress notifications.

NOTE: if there is an error like "errors reported during linting after fixing", you can use this to be even more verbose for debugging purpose

* ``--verbose=0`` or no option: normal
* ``--verbose``, ``--verbose=1``, ``-v``: verbose
* ``--verbose=2``, ``-vv``: very verbose
* ``--verbose=3``, ``-vvv``: debug

The ``--rules`` option limits the rules to apply to the
project:

Expand Down
8 changes: 8 additions & 0 deletions src/Console/Command/HelpCommand.php
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,17 @@ public static function getHelpCopy()
* ``junit`` follows the `JUnit xml schema from Jenkins </doc/junit-10.xsd>`_
* ``checkstyle`` follows the common `"checkstyle" xml schema </doc/checkstyle.xsd>`_
The <comment>--quiet</comment> Do not output any message.
The <comment>--verbose</comment> option will show the applied rules. When using the ``txt`` format it will also display progress notifications.
NOTE: if there is an error like "errors reported during linting after fixing", you can use this to be even more verbose for debugging purpose
* ``--verbose=0`` or no option: normal
* ``--verbose``, ``--verbose=1``, ``-v``: verbose
* ``--verbose=2``, ``-vv``: very verbose
* ``--verbose=3``, ``-vvv``: debug
The <comment>--rules</comment> option limits the rules to apply to the
project:
Expand Down

0 comments on commit f9fd467

Please sign in to comment.