Skip to content

Commit

Permalink
split FAQ into subheadings
Browse files Browse the repository at this point in the history
  • Loading branch information
dgw committed Nov 29, 2023
1 parent 8038cab commit 2a4c1c0
Showing 1 changed file with 25 additions and 10 deletions.
35 changes: 25 additions & 10 deletions docs/source/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,16 +65,31 @@ Log files' names start with :ref:`their associated config file's name
<logging-basename>`, i.e. the :option:`--config <sopel start --config>`
argument's value.

There are two main log types you might be asked to provide:

* ``<configname>.sopel.log``: Everything Sopel does from startup to shutdown.
In normal operation, the ``INFO`` (default) or ``WARNING``
:attr:`~.config.core_section.CoreSection.logging_level` is sufficient, but you
might be asked to enable ``DEBUG`` logging and reproduce your problem to help
Sopel's developers determine what's happening.
* ``<configname>.raw.log``: Raw traffic between Sopel and the IRC server. Not
enabled by default; turn it on if needed using the
:attr:`~.config.core_section.CoreSection.log_raw` setting in your config file.
There are two main log types you might be asked to provide: ``sopel`` logs and
``raw`` logs.

Obtaining ``sopel`` logs
------------------------

``<configname>.sopel.log`` files contain everything Sopel does from startup to
shutdown.

In normal operation, the ``INFO`` (default) or ``WARNING``
:attr:`~.config.core_section.CoreSection.logging_level` is usually sufficient.
For ambiguous or particularly gnarly problems, you might be asked to enable
``DEBUG`` logging and reproduce your issue to help Sopel's developers understand
what's happening.

Obtaining ``raw`` logs
----------------------

For certain problem types, a developer might ask for ``raw`` logs to examine
exactly what Sopel and the IRC server are saying to each other.

These ``<configname>.raw.log`` files are not enabled by default. If requested
by the person helping you in our issue tracker or IRC channel, you can turn
``raw`` logs on using the :attr:`~.config.core_section.CoreSection.log_raw`
setting in your config file.

.. warning::

Expand Down

0 comments on commit 2a4c1c0

Please sign in to comment.