Skip to content

Commit 5f45e5a

Browse files
authored
Merge pull request #85181 from carlpeto/fix-docs-backtrace-options
Fix a few small discrepancies in the docs about options for backtrace.
2 parents 1f93003 + 825d82f commit 5f45e5a

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

docs/Backtracing.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,13 @@ follows:
4444
| Key | Default | Meaning |
4545
+=================+=========+==================================================+
4646
| enable | yes* | Set to ``no`` to disable crash catching, or |
47-
| | | ``tty`` to enable only if stdin is a terminal. |
47+
| | | ``tty`` to enable only if stdout is a terminal. |
4848
+-----------------+---------+--------------------------------------------------+
4949
| demangle | yes | Set to ``no`` to disable demangling. |
5050
+-----------------+---------+--------------------------------------------------+
5151
| interactive | tty | Set to ``no`` to disable interaction, or ``yes`` |
52-
| | | to enable always. |
52+
| | | to enable always, or `tty`` to enable only if |
53+
| | | stdin and stdout are both a terminal. |
5354
+-----------------+---------+--------------------------------------------------+
5455
| color | tty | Set to ``yes`` to enable always, or ``no`` to |
5556
| | | disable. Uses ANSI escape sequences. |
@@ -95,8 +96,8 @@ follows:
9596
| format | text | Set to ``json`` to output JSON crash logs rather |
9697
| | | than plain text. |
9798
+-----------------+---------+--------------------------------------------------+
98-
| output-to | stdout | Set to ``stderr`` to send the backtrace to the |
99-
| | | standard error instead of standard output. This |
99+
| output-to | stderr | Set to ``stdout`` to send the backtrace to the |
100+
| | | standard output instead of standard error. This |
100101
| | | may be useful in some CI systems. |
101102
| | | |
102103
| | | You may also specify a path; if this points at a |
@@ -118,7 +119,8 @@ follows:
118119
| | | sometimes useful for testing. |
119120
+-----------------+---------+--------------------------------------------------+
120121

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

123125
Backtrace limits
124126
----------------

0 commit comments

Comments
 (0)