Skip to content

Commit b799498

Browse files
sam-githubaddaleax
authored andcommitted
src: document --abort-on-uncaught-exception
Its important for post-mortem diagnostics and should be more prominently documented. PR-URL: #13931 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: Julien Gilli <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
1 parent 2a86650 commit b799498

File tree

3 files changed

+15
-0
lines changed

3 files changed

+15
-0
lines changed

doc/api/cli.md

+8
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,14 @@ added: v8.0.0
178178
Enable loading native modules compiled with the ABI-stable Node.js API (N-API)
179179
(experimental).
180180

181+
## `--abort-on-uncaught-exception`
182+
<!-- YAML
183+
added: v0.10
184+
-->
185+
186+
Aborting instead of exiting causes a core file to be generated for post-mortem
187+
analysis using a debugger (such as `lldb`, `gdb`, and `mdb`).
188+
181189
### `--trace-warnings`
182190
<!-- YAML
183191
added: v6.0.0

doc/node.1

+4
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,10 @@ Silence all process warnings (including deprecations).
135135
Enable loading native modules compiled with the ABI-stable Node.js API (N-API)
136136
(experimental).
137137

138+
.TP
139+
.BR \-\-abort\-on\-uncaught\-exception
140+
Aborting instead of exiting causes a core file to be generated for analysis.
141+
138142
.TP
139143
.BR \-\-trace\-warnings
140144
Print stack traces for process warnings (including deprecations).

src/node.cc

+3
Original file line numberDiff line numberDiff line change
@@ -3645,6 +3645,9 @@ static void PrintHelp() {
36453645
" --pending-deprecation emit pending deprecation warnings\n"
36463646
" --no-warnings silence all process warnings\n"
36473647
" --napi-modules load N-API modules\n"
3648+
" --abort-on-uncaught-exception\n"
3649+
" aborting instead of exiting causes a\n"
3650+
" core file to be generated for analysis\n"
36483651
" --trace-warnings show stack traces on process warnings\n"
36493652
" --redirect-warnings=file\n"
36503653
" write warnings to file instead of\n"

0 commit comments

Comments
 (0)