Skip to content

Commit 7c554a5

Browse files
committed
doc: document reserved status of SIGUSR1
Fixes #1212.
1 parent 5bda2be commit 7c554a5

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

doc/api/process.markdown

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,10 @@ You have been warned.
6060
## Signal Events
6161

6262
<!--type=event-->
63-
<!--name=SIGINT, SIGUSR1, etc.-->
63+
<!--name=SIGINT, SIGHUP, etc.-->
6464

6565
Emitted when the processes receives a signal. See sigaction(2) for a list of
66-
standard POSIX signal names such as SIGINT, SIGUSR1, etc.
66+
standard POSIX signal names such as SIGINT, SIGHUP, etc.
6767

6868
Example of listening for `SIGINT`:
6969

@@ -77,6 +77,8 @@ Example of listening for `SIGINT`:
7777
An easy way to send the `SIGINT` signal is with `Control-C` in most terminal
7878
programs.
7979

80+
Note: SIGUSR1 is reserved by node.js to kickstart the debugger. It's possible
81+
to install a listener but that won't stop the debugger from starting.
8082

8183
## process.stdout
8284

@@ -391,7 +393,7 @@ An example of the possible output looks like:
391393

392394
Send a signal to a process. `pid` is the process id and `signal` is the
393395
string describing the signal to send. Signal names are strings like
394-
'SIGINT' or 'SIGUSR1'. If omitted, the signal will be 'SIGTERM'.
396+
'SIGINT' or 'SIGHUP'. If omitted, the signal will be 'SIGTERM'.
395397
See kill(2) for more information.
396398

397399
Note that just because the name of this function is `process.kill`, it is
@@ -411,6 +413,8 @@ Example of sending a signal to yourself:
411413

412414
process.kill(process.pid, 'SIGHUP');
413415

416+
Note: SIGUSR1 is reserved by node.js. It can be used to kickstart the
417+
debugger.
414418

415419
## process.pid
416420

0 commit comments

Comments
 (0)