Skip to content

Fix a few small discrepancies in the docs about options for backtrace. #85181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 29, 2025
Merged

Fix a few small discrepancies in the docs about options for backtrace. #85181

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a2c24ea
Fix a few small discrepancies in the docs about options for backtrace.
carlpeto Oct 22, 2025
fdbbf31
Update docs/Backtracing.rst
carlpeto Oct 28, 2025
43c84ea
Update docs/Backtracing.rst
carlpeto Oct 28, 2025
825d82f
Update docs/Backtracing.rst
carlpeto Oct 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions docs/Backtracing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,13 @@ follows:
| Key | Default | Meaning |
+=================+=========+==================================================+
| enable | yes* | Set to ``no`` to disable crash catching, or |
| | | ``tty`` to enable only if stdin is a terminal. |
| | | ``tty`` to enable only if stdout is a terminal. |
+-----------------+---------+--------------------------------------------------+
| demangle | yes | Set to ``no`` to disable demangling. |
+-----------------+---------+--------------------------------------------------+
| interactive | tty | Set to ``no`` to disable interaction, or ``yes`` |
| | | to enable always. |
| | | to enable always, or `tty`` to enable only if |
| | | stdin and stdout are both a terminal. |
+-----------------+---------+--------------------------------------------------+
| color | tty | Set to ``yes`` to enable always, or ``no`` to |
| | | disable. Uses ANSI escape sequences. |
Expand Down Expand Up @@ -95,8 +96,8 @@ follows:
| format | text | Set to ``json`` to output JSON crash logs rather |
| | | than plain text. |
+-----------------+---------+--------------------------------------------------+
| output-to | stdout | Set to ``stderr`` to send the backtrace to the |
| | | standard error instead of standard output. This |
| output-to | stderr | Set to ``stdout`` to send the backtrace to the |
| | | standard output instead of standard error. This |
| | | may be useful in some CI systems. |
| | | |
| | | You may also specify a path; if this points at a |
Expand All @@ -118,7 +119,8 @@ follows:
| | | sometimes useful for testing. |
+-----------------+---------+--------------------------------------------------+

(*) On macOS, this defaults to ``no`` rather than ``yes``.
(*) On macOS 26 and later, this defaults to ``tty`` rather than ``yes``. On
earlier versions, the default is ``no``.

Backtrace limits
----------------
Expand Down