doc: join parts of disrupt section in cli.md

Also eliminate some redundancy. PR-URL: #30038 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Yongsheng Zhang <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
nodejs · Nov 11, 2019 · 870c320 · 870c320
1 parent 21a43bd
commit 870c320
Showing 1 changed file with 2 additions and 4 deletions.
diff --git a/doc/api/cli.md b/doc/api/cli.md
@@ -244,7 +244,8 @@ added: v12.0.0
 -->
 
 Enables a signal handler that causes the Node.js process to write a heap dump
-when the specified signal is received.
+when the specified signal is received. `signal` must be a valid signal name.
+Disabled by default.
 
 ```console
 $ node --heapsnapshot-signal=SIGUSR2 index.js &
@@ -307,9 +308,6 @@ added: v12.4.0
 
 Specify the file name of the heap profile generated by `--heap-prof`.
 
-Generates a heap snapshot each time the process receives the specified signal.
-`signal` must be a valid signal name. Disabled by default.
-
 ### `--http-parser=library`
 <!-- YAML
 added: v11.4.0