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

docs: improve 'all' stream and 'full.log' docs #6050

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all 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
3 changes: 3 additions & 0 deletions docs/source/guides/user/chapters/logging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,9 @@ from all tests in one place.
.. note:: You have to specify separated logging streams. You can't use the
built-in streams in this function.

.. note:: There's a special stream 'all' that let's you store all streams into the
``full.log`` file in the job result directory.


.. _avocado-log-files:

Expand Down
2 changes: 1 addition & 1 deletion docs/source/guides/writer/chapters/logging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ The very same ``avocado.test.progress`` logger, could be used across multiple te
and across multiple test modules.

By default avocado is creating ``full.log`` file in job_log directory with
all avocado logs which were created during the job run::
all avocado logs which were created during the job run, ie. ``--store-logging-stream=all`` is the default if not specified otherwise::

$ avocado run examples/tests/logging_streams.py

Expand Down
2 changes: 2 additions & 0 deletions man/avocado.rst
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,8 @@ Options for subcommand `run` (`avocado run --help`)::
--store-logging-stream LOGGING_STREAM
Store given logging STREAMs in
"$JOB_RESULTS_DIR/$STREAM.$LEVEL".
LOGGING_STREAM=all is the default and will store all logs
into the file "$JOB_RESULTS_DIR/full.log"
--xunit FILE Enable xUnit result format and write it to FILE. Use
"-" to redirect to the standard output.
--disable-xunit-job-result
Expand Down
Loading