src: document --abort-on-uncaught-exception

sam-github · addaleax · commit b799498e8af9 · 2017-07-18T19:58:18.000+02:00
Its important for post-mortem diagnostics and should be more prominently documented. PR-URL: #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>
diff --git 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
@@ -135,6 +135,10 @@ Silence all process warnings (including deprecations).
 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).
diff --git a/src/node.cc b/src/node.cc
@@ -3645,6 +3645,9 @@ static void PrintHelp() {
          "  --pending-deprecation      emit pending deprecation warnings\n"
          "  --no-warnings              silence all process warnings\n"
          "  --napi-modules             load N-API modules\n"
+         "  --abort-on-uncaught-exception\n"
+         "                             aborting instead of exiting causes a\n"
+         "                             core file to be generated for analysis\n"
          "  --trace-warnings           show stack traces on process warnings\n"
          "  --redirect-warnings=file\n"
          "                             write warnings to file instead of\n"
