Skip to content

Commit

Permalink
add a note about status codes in readme
Browse files Browse the repository at this point in the history
detail that err code won't reflect unexpected sigkill or sigterm
  • Loading branch information
adriendelsalle authored and DaanDeMeyer committed Feb 14, 2022
1 parent 8aea3ae commit 0adc53c
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,16 @@ occurred. You can test against these error codes using values from the

See the examples for more information on how to handle errors when using reproc.

Note:

Both reproc and reproc++ APIs take `options` argument that may define one or more
`stop` actions such as `terminate` or `kill`.
For that reason if the child process is being terminated or killed using a signal
on POSIX, the error code will **not** reflect an error.

It's up to the downstream project to *interpret* status codes reflecting unexpected
behaviors alongside error codes (see this [example](https://github.com/DaanDeMeyer/reproc/issues/68#issuecomment-959074504)).

## Multithreading

Don't call the same operation on the same child process from more than one
Expand Down

0 comments on commit 0adc53c

Please sign in to comment.