Skip to content

Commit eb4715d

Browse files
spacewanderthibaultcha
authored andcommitted
doc: ngx.pipe: mentioned lua-resty-signal's signum() function.
Signed-off-by: Thibault Charbonnier <thibaultcha@me.com>
1 parent b4c6bd2 commit eb4715d

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

lib/ngx/pipe.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -283,6 +283,11 @@ Sends a signal to the sub-process.
283283
Note that the `signum` argument should be signal's numerical value. If the
284284
specified `signum` is not a number, an error will be thrown.
285285

286+
You should use [lua-resty-signal's signum()
287+
function](https://github.com/openresty/lua-resty-signal#signum) to convert
288+
signal names to signal numbers in order to ensure portability of your
289+
application.
290+
286291
In case of success, this method returns `true`. Otherwise, it returns `nil` and
287292
a string describing the error.
288293

0 commit comments

Comments
 (0)