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.

Sign up for GitHub

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

Jump to bottom

doc/usage: adjust docs for legacy --lg-colored-steps, LG_COLOR_SCHEME #1448

Merged
merged 1 commit into from
Jul 23, 2024
Merged

doc/usage: adjust docs for legacy --lg-colored-steps, LG_COLOR_SCHEME #1448

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 3 additions & 19 deletions doc/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -447,12 +447,9 @@ Other labgrid-related pytest plugin options are:
If option is specified without path the current working directory is used.

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

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

.. _usage-lgcolorscheme:

LG_COLOR_SCHEME
^^^^^^^^^^^^^^^
Influences the color scheme used for the Colored Step Reporter.
``dark`` is meant for dark terminal background.
``light`` is optimized for light terminal background.
``dark-256color`` and ``light-256color`` are respective variants for terminals
that support 256 colors.
By default, ``dark`` or ``dark-256color`` (depending on the terminal) are used.

Takes effect only when used with ``--lg-colored-steps``.

LG_PROXY
^^^^^^^^
Specifies a SSH proxy host to be used for port forwards to access the
Expand Down
Loading