Skip to content

Commit a2c24ea

Browse files
committed
Fix a few small discrepancies in the docs about options for backtrace.
1 parent 3a0b392 commit a2c24ea

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

docs/Backtracing.rst

Lines changed: 5 additions & 4 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. `tty`` to enable only if |
53+
| | | stdin and stdout are are both a terminal. |
5354
+-----------------+---------+--------------------------------------------------+
5455
| color | tty | Set to ``yes`` to enable always, or ``no`` to |
5556
| | | disable. Uses ANSI escape sequences. |
@@ -95,7 +96,7 @@ 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+
| output-to | stderr | Set to ``stderr`` to send the backtrace to the |
99100
| | | standard error instead of standard output. This |
100101
| | | may be useful in some CI systems. |
101102
| | | |
@@ -118,7 +119,7 @@ follows:
118119
| | | sometimes useful for testing. |
119120
+-----------------+---------+--------------------------------------------------+
120121

121-
(*) On macOS, this defaults to ``no`` rather than ``yes``.
122+
(*) On macOS, this defaults to ``tty`` rather than ``yes``.
122123

123124
Backtrace limits
124125
----------------

0 commit comments

Comments
 (0)