5cd15560e4
So far, the Tobiko docs were duplicated in some places, different
(although duplicated), and some fragments were not relevant (or
outdated).
This patch refactors the configuration part of Tobiko quick start guide
by modularizing the fragments ("spilling" fragments instead of coping
them), correcting typos, and deleting/updating irrelevant information.
Note: in order to see how the change will appear, download it with
`git review -d <change_url>`, run the `tox -e docs` command, and then
double click
(with the file explorer) tobiko/doc/build/html/<file-you-want>.
Change-Id: Ibb27382ec3c7a8969686cfd89c2205cdd2dd2525
26 lines
894 B
ReStructuredText
26 lines
894 B
ReStructuredText
.. _conf_logging:
|
|
|
|
Configure Logging
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
.. configure-tobiko-logging-label
|
|
|
|
Tobiko can configure a logging system to write messages to a log file. You can
|
|
edit the below options in :ref:`tobiko-conf` to enable it as below::
|
|
|
|
[DEFAULT]
|
|
# Whenever to allow debugging messages to be written out or not
|
|
debug = true
|
|
|
|
# Name of the file where log messages will be appended.
|
|
log_file = tobiko.log
|
|
|
|
# The base directory used for relative log_file paths.
|
|
log_dir = .
|
|
|
|
The file 'tobiko.log' is the default file where test cases and the Python framework
|
|
are going to write their logging messages. By setting debug as 'True' you
|
|
ensure that messages with the lowest logging level are written there (DEBUG level).
|
|
The log_file location specified above is relative to the tobiko.conf file
|
|
location. In this example it is the Tobiko source files' directory itself.
|