summaryrefslogtreecommitdiffstats
path: root/Doc/library/faulthandler.rst
diff options
context:
space:
mode:
authorBenjamin Peterson <benjamin@python.org>2011-06-19 14:37:18 (GMT)
committerBenjamin Peterson <benjamin@python.org>2011-06-19 14:37:18 (GMT)
commitdefe6f61fe8595d0d2cc194c120ef0b3dc3a4286 (patch)
treeb52230f7e62249cc9a9da6cd35bf15af6be80882 /Doc/library/faulthandler.rst
parent85198753f16a6f81ad43223a65adddaf50e14fad (diff)
downloadcpython-defe6f61fe8595d0d2cc194c120ef0b3dc3a4286.zip
cpython-defe6f61fe8595d0d2cc194c120ef0b3dc3a4286.tar.gz
cpython-defe6f61fe8595d0d2cc194c120ef0b3dc3a4286.tar.bz2
clarify
Diffstat (limited to 'Doc/library/faulthandler.rst')
-rw-r--r--Doc/library/faulthandler.rst12
1 files changed, 6 insertions, 6 deletions
diff --git a/Doc/library/faulthandler.rst b/Doc/library/faulthandler.rst
index 83f9cca..b0f8cb4 100644
--- a/Doc/library/faulthandler.rst
+++ b/Doc/library/faulthandler.rst
@@ -43,9 +43,8 @@ Dump the traceback
.. function:: dump_traceback(file=sys.stderr, all_threads=True)
- Dump the traceback of all threads into *file*. If *all_threads* is ``True``,
- produce tracebacks for every running thread. Otherwise, dump only the current
- thread.
+ Dump the tracebacks of all threads into *file*. If *all_threads* is
+ ``False``, dump only the current thread.
Fault handler state
@@ -77,9 +76,10 @@ Dump the tracebacks after a timeout
Dump the tracebacks of all threads, after a timeout of *timeout* seconds, or
every *timeout* seconds if *repeat* is ``True``. If *exit* is ``True``, call
:c:func:`_exit` with status=1 after dumping the tracebacks. (Note
- :c:func:`_exit` doesn't flush file buffers.) If the function is called twice,
- the new call replaces previous parameters and resets the timeout. The timer
- has a sub-second resolution.
+ :c:func:`_exit` exits the process immediately, which means it doesn't do any
+ cleanup like flushing file buffers.) If the function is called twice, the new
+ call replaces previous parameters and resets the timeout. The timer has a
+ sub-second resolution.
This function is implemented using a watchdog thread and therefore is not
available if Python is compiled with threads disabled.