summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorVinay Sajip <vinay_sajip@yahoo.co.uk>2014-01-15 13:28:39 (GMT)
committerVinay Sajip <vinay_sajip@yahoo.co.uk>2014-01-15 13:28:39 (GMT)
commit350e623623a95466fc8cefc08884d5c131deadc4 (patch)
treef7ed99ed75a4299c9375db6d5ba1cc6a8a285c22 /Doc
parent71337cb28199c0cf6d90f54bc5559bc75159077f (diff)
downloadcpython-350e623623a95466fc8cefc08884d5c131deadc4.zip
cpython-350e623623a95466fc8cefc08884d5c131deadc4.tar.gz
cpython-350e623623a95466fc8cefc08884d5c131deadc4.tar.bz2
Clarified documentation note on module-level convenience functions.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/logging.rst17
1 files changed, 9 insertions, 8 deletions
diff --git a/Doc/library/logging.rst b/Doc/library/logging.rst
index 14ccb25..cf4893c 100644
--- a/Doc/library/logging.rst
+++ b/Doc/library/logging.rst
@@ -1002,14 +1002,15 @@ functions.
Logs a message with level *level* on the root logger. The other arguments are
interpreted as for :func:`debug`.
- .. note:: The above module-level functions which delegate to the root
- logger should *not* be used in threads, in versions of Python earlier
- than 2.7.1 and 3.2, unless at least one handler has been added to the
- root logger *before* the threads are started. These convenience functions
- call :func:`basicConfig` to ensure that at least one handler is
- available; in earlier versions of Python, this can (under rare
- circumstances) lead to handlers being added multiple times to the root
- logger, which can in turn lead to multiple messages for the same event.
+ .. note:: The above module-level convenience functions, which delegate to the
+ root logger, call :func:`basicConfig` to ensure that at least one handler
+ is available. Because of this, they should *not* be used in threads,
+ in versions of Python earlier than 2.7.1 and 3.2, unless at least one
+ handler has been added to the root logger *before* the threads are
+ started. In earlier versions of Python, due to a thread safety shortcoming
+ in :func:`basicConfig`, this can (under rare circumstances) lead to
+ handlers being added multiple times to the root logger, which can in turn
+ lead to multiple messages for the same event.
.. function:: disable(lvl)