From c23baf859ec6e95b6133db1f4c3345b300ab105c Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Thu, 8 Nov 2012 23:15:13 +0100 Subject: [PATCH] docs: Formatting --- docs/changes.rst | 5 +++-- docs/development.rst | 10 +++++----- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/changes.rst b/docs/changes.rst index a36ee180..3499fb04 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -89,8 +89,9 @@ backends: - Added support for search by filename to local backend. - Added optional background thread for debugging deadlocks. When the feature is - enabled via the ``--debug-thread`` or ``settings.DEBUG_THREAD`` a ``SIGUSR1`` - signal will dump the traceback for all running threads. + enabled via the ``--debug-thread`` option or + :attr:`mopidy.settings.DEBUG_THREAD` setting a ``SIGUSR1`` signal will dump + the traceback for all running threads. **Bug fixes** diff --git a/docs/development.rst b/docs/development.rst index 00a1d46a..5c01d6d0 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -287,12 +287,12 @@ if you for instance want to test Spotify without any actual audio output. Debugging deadlocks =================== -Between the numerous pykka threads and gstreamer interactions there can +Between the numerous Pykka threads and GStreamer interactions there can sometimes be a potential for deadlocks. In an effort to make these slightly -simpler to debug ``settings.DEBUG_THREAD`` or ``--debug-thread`` -can be used to turn on an extra debug thread. This thread is not linked to -the regular program flow, and it's only task is to dump traceback showing -the other threads state when we get a ``SIGUSR1``. +simpler to debug the setting :attr:`mopidy.settings.DEBUG_THREAD` or the option +``--debug-thread`` can be used to turn on an extra debug thread. This thread is +not linked to the regular program flow, and it's only task is to dump traceback +showing the other threads state when we get a ``SIGUSR1``. Writing documentation