Skip to content

Commit fe10000

Browse files
Merge pull request #1448 from Bastian-Krause/bst/lg-colored-steps
doc/usage: adjust docs for legacy --lg-colored-steps, LG_COLOR_SCHEME
2 parents 5755430 + fe7b570 commit fe10000

File tree

1 file changed

+3
-19
lines changed

1 file changed

+3
-19
lines changed

doc/usage.rst

Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -447,12 +447,9 @@ Other labgrid-related pytest plugin options are:
447447
If option is specified without path the current working directory is used.
448448

449449
``--lg-colored-steps``
450-
Enables the ColoredStepReporter.
451-
Different events have different colors.
452-
The more colorful, the more important.
453-
In order to make less important output "blend into the background" different
454-
color schemes are available.
455-
See :ref:`LG_COLOR_SCHEME <usage-lgcolorscheme>`.
450+
Previously enabled the ColoredStepReporter, which has been removed with the
451+
StepLogger introduction.
452+
Kept for compatibility reasons without effect.
456453

457454
``--lg-initial-state=STATE_NAME``
458455
Sets the Strategy's initial state.
@@ -470,19 +467,6 @@ LG_ENV
470467
^^^^^^
471468
Behaves like ``LG_ENV`` for :doc:`labgrid-client <man/client>`.
472469

473-
.. _usage-lgcolorscheme:
474-
475-
LG_COLOR_SCHEME
476-
^^^^^^^^^^^^^^^
477-
Influences the color scheme used for the Colored Step Reporter.
478-
``dark`` is meant for dark terminal background.
479-
``light`` is optimized for light terminal background.
480-
``dark-256color`` and ``light-256color`` are respective variants for terminals
481-
that support 256 colors.
482-
By default, ``dark`` or ``dark-256color`` (depending on the terminal) are used.
483-
484-
Takes effect only when used with ``--lg-colored-steps``.
485-
486470
LG_PROXY
487471
^^^^^^^^
488472
Specifies a SSH proxy host to be used for port forwards to access the

0 commit comments

Comments
 (0)