diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2024-04-28 18:41:02 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-04-28 18:41:02 (GMT) |
| commit | 817190c303e0650d7da5e52e82feb6505fc6b761 (patch) | |
| tree | 4616c74e36b374e06cada74b2cfbcc4b039da026 | |
| parent | 9a91c7051f3dc72352e1755d8519271cc908298b (diff) | |
| download | cpython-817190c303e0650d7da5e52e82feb6505fc6b761.zip cpython-817190c303e0650d7da5e52e82feb6505fc6b761.tar.gz cpython-817190c303e0650d7da5e52e82feb6505fc6b761.tar.bz2 | |
[3.12] gh-101100: Fix Sphinx warnings in `library/faulthandler.rst` (GH-118353) (#118366)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
| -rw-r--r-- | Doc/library/faulthandler.rst | 16 | ||||
| -rw-r--r-- | Doc/tools/.nitignore | 1 |
2 files changed, 9 insertions, 8 deletions
diff --git a/Doc/library/faulthandler.rst b/Doc/library/faulthandler.rst index 96593ee..c40d5e9 100644 --- a/Doc/library/faulthandler.rst +++ b/Doc/library/faulthandler.rst @@ -10,14 +10,15 @@ This module contains functions to dump Python tracebacks explicitly, on a fault, after a timeout, or on a user signal. Call :func:`faulthandler.enable` to -install fault handlers for the :const:`SIGSEGV`, :const:`SIGFPE`, -:const:`SIGABRT`, :const:`SIGBUS`, and :const:`SIGILL` signals. You can also +install fault handlers for the :const:`~signal.SIGSEGV`, +:const:`~signal.SIGFPE`, :const:`~signal.SIGABRT`, :const:`~signal.SIGBUS`, and +:const:`~signal.SIGILL` signals. You can also enable them at startup by setting the :envvar:`PYTHONFAULTHANDLER` environment variable or by using the :option:`-X` ``faulthandler`` command line option. The fault handler is compatible with system fault handlers like Apport or the Windows fault handler. The module uses an alternative stack for signal handlers -if the :c:func:`sigaltstack` function is available. This allows it to dump the +if the :c:func:`!sigaltstack` function is available. This allows it to dump the traceback even on a stack overflow. The fault handler is called on catastrophic cases and therefore can only use @@ -70,8 +71,9 @@ Fault handler state .. function:: enable(file=sys.stderr, all_threads=True) - Enable the fault handler: install handlers for the :const:`SIGSEGV`, - :const:`SIGFPE`, :const:`SIGABRT`, :const:`SIGBUS` and :const:`SIGILL` + Enable the fault handler: install handlers for the :const:`~signal.SIGSEGV`, + :const:`~signal.SIGFPE`, :const:`~signal.SIGABRT`, :const:`~signal.SIGBUS` + and :const:`~signal.SIGILL` signals to dump the Python traceback. If *all_threads* is ``True``, produce tracebacks for every running thread. Otherwise, dump only the current thread. @@ -106,8 +108,8 @@ Dumping 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` exits the process immediately, which means it doesn't do any + :c:func:`!_exit` with status=1 after dumping the tracebacks. (Note + :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. diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore index 7b7fe86..108ad39 100644 --- a/Doc/tools/.nitignore +++ b/Doc/tools/.nitignore @@ -35,7 +35,6 @@ Doc/library/email.errors.rst Doc/library/email.parser.rst Doc/library/email.policy.rst Doc/library/exceptions.rst -Doc/library/faulthandler.rst Doc/library/functools.rst Doc/library/getopt.rst Doc/library/http.cookiejar.rst |