Skip to content

Commit 2a4c1c0

Browse files
committed
split FAQ into subheadings
1 parent 8038cab commit 2a4c1c0

File tree

1 file changed

+25
-10
lines changed

1 file changed

+25
-10
lines changed

docs/source/faq.rst

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -65,16 +65,31 @@ Log files' names start with :ref:`their associated config file's name
6565
<logging-basename>`, i.e. the :option:`--config <sopel start --config>`
6666
argument's value.
6767

68-
There are two main log types you might be asked to provide:
69-
70-
* ``<configname>.sopel.log``: Everything Sopel does from startup to shutdown.
71-
In normal operation, the ``INFO`` (default) or ``WARNING``
72-
:attr:`~.config.core_section.CoreSection.logging_level` is sufficient, but you
73-
might be asked to enable ``DEBUG`` logging and reproduce your problem to help
74-
Sopel's developers determine what's happening.
75-
* ``<configname>.raw.log``: Raw traffic between Sopel and the IRC server. Not
76-
enabled by default; turn it on if needed using the
77-
:attr:`~.config.core_section.CoreSection.log_raw` setting in your config file.
68+
There are two main log types you might be asked to provide: ``sopel`` logs and
69+
``raw`` logs.
70+
71+
Obtaining ``sopel`` logs
72+
------------------------
73+
74+
``<configname>.sopel.log`` files contain everything Sopel does from startup to
75+
shutdown.
76+
77+
In normal operation, the ``INFO`` (default) or ``WARNING``
78+
:attr:`~.config.core_section.CoreSection.logging_level` is usually sufficient.
79+
For ambiguous or particularly gnarly problems, you might be asked to enable
80+
``DEBUG`` logging and reproduce your issue to help Sopel's developers understand
81+
what's happening.
82+
83+
Obtaining ``raw`` logs
84+
----------------------
85+
86+
For certain problem types, a developer might ask for ``raw`` logs to examine
87+
exactly what Sopel and the IRC server are saying to each other.
88+
89+
These ``<configname>.raw.log`` files are not enabled by default. If requested
90+
by the person helping you in our issue tracker or IRC channel, you can turn
91+
``raw`` logs on using the :attr:`~.config.core_section.CoreSection.log_raw`
92+
setting in your config file.
7893

7994
.. warning::
8095

0 commit comments

Comments
 (0)