Skip to content

Commit

Permalink
docs: cleanup old mention of --show-progress=estimating in docs (#7287
Browse files Browse the repository at this point in the history
)
  • Loading branch information
verfriemelt-dot-org authored Sep 11, 2023
1 parent c7a21ed commit b6e97ea
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,13 +87,13 @@ The ``--stop-on-violation`` flag stops the execution upon first file that needs
The ``--show-progress`` option allows you to choose the way process progress is rendered:

* ``none``: disables progress output;
* ``dots``: same as ``estimating`` but using all terminal columns instead of default 80.
* ``dots``: multiline progress output with number of files and percentage on each line. Note that with this option, the files list is evaluated before processing to get the total number of files and then kept in memory to avoid using the file iterator twice. This has an impact on memory usage so using this option is not recommended on very large projects;

If the option is not provided, it defaults to ``dots`` unless a config file that disables output is used, in which case it defaults to ``none``. This option has no effect if the verbosity of the command is less than ``verbose``.

.. code-block:: console
php php-cs-fixer.phar fix --verbose --show-progress=estimating
php php-cs-fixer.phar fix --verbose --show-progress=dots
The command can also read from standard input, in which case it won't
automatically fix anything:
Expand Down

0 comments on commit b6e97ea

Please sign in to comment.