summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSam Roberts <vieuxtech@gmail.com>2017-06-26 11:00:34 -0700
committerSam Roberts <vieuxtech@gmail.com>2017-07-06 14:09:01 -0700
commit388e552579aff6b5152c67adeda182d2d40e8dfc (patch)
treea586b5bff769718809c4e1a250fefc7eb546a2ab /doc
parent9c6804c1dff0203751dd01da4e226e19de636a71 (diff)
downloadnode-new-388e552579aff6b5152c67adeda182d2d40e8dfc.tar.gz
src: document --abort-on-uncaught-exception
Its important for post-mortem diagnostics and should be more prominently documented. PR-URL: https://github.com/nodejs/node/pull/13931 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Julien Gilli <jgilli@nodejs.org> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/cli.md8
-rw-r--r--doc/node.14
2 files changed, 12 insertions, 0 deletions
diff --git a/doc/api/cli.md b/doc/api/cli.md
index 0c88eeca17..fd2c4d0bd1 100644
--- a/doc/api/cli.md
+++ b/doc/api/cli.md
@@ -178,6 +178,14 @@ added: v8.0.0
Enable loading native modules compiled with the ABI-stable Node.js API (N-API)
(experimental).
+## `--abort-on-uncaught-exception`
+<!-- YAML
+added: v0.10
+-->
+
+Aborting instead of exiting causes a core file to be generated for post-mortem
+analysis using a debugger (such as `lldb`, `gdb`, and `mdb`).
+
### `--trace-warnings`
<!-- YAML
added: v6.0.0
diff --git a/doc/node.1 b/doc/node.1
index af9069f134..ca142a2cab 100644
--- a/doc/node.1
+++ b/doc/node.1
@@ -136,6 +136,10 @@ Enable loading native modules compiled with the ABI-stable Node.js API (N-API)
(experimental).
.TP
+.BR \-\-abort\-on\-uncaught\-exception
+Aborting instead of exiting causes a core file to be generated for analysis.
+
+.TP
.BR \-\-trace\-warnings
Print stack traces for process warnings (including deprecations).