Skip to content

Commit

Permalink
[7.1.x] Fix wrong log_file docs (#9879)
Browse files Browse the repository at this point in the history
Co-authored-by: Zac Hatfield-Dodds <[email protected]>
  • Loading branch information
github-actions[bot] and Zac-HD authored Apr 22, 2022
1 parent 078733c commit 5c04f3a
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
2 changes: 2 additions & 0 deletions doc/en/how-to/logging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,8 @@ option names are:
If you need to record the whole test suite logging calls to a file, you can pass
``--log-file=/path/to/log/file``. This log file is opened in write mode which
means that it will be overwritten at each run tests session.
Note that relative paths for the log-file location, whether passed on the CLI or declared in a
config file, are always resolved relative to the current working directory.

You can also specify the logging level for the log file by passing
``--log-file-level``. This setting accepts the logging level names as seen in
Expand Down
2 changes: 1 addition & 1 deletion doc/en/reference/reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1514,7 +1514,7 @@ passed multiple times. The expected format is ``name=value``. For example::



Sets a file name relative to the ``pytest.ini`` file where log messages should be written to, in addition
Sets a file name relative to the current working directory where log messages should be written to, in addition
to the other logging facilities that are active.

.. code-block:: ini
Expand Down

0 comments on commit 5c04f3a

Please sign in to comment.