aboutsummaryrefslogtreecommitdiffhomepage
path: root/core/init.lua
diff options
context:
space:
mode:
authorGravatar mitchell <70453897+667e-11@users.noreply.github.com>2015-03-26 12:38:51 -0400
committerGravatar mitchell <70453897+667e-11@users.noreply.github.com>2015-03-26 12:38:51 -0400
commitc6d0c081de184df002e9e5c04373b9b9753754e3 (patch)
treee175c30313ab57131cd2b9de7af58b8eaa567f5b /core/init.lua
parent90c7036ab273fc1c76e3247bbbf7af74f9f0ed35 (diff)
Document optional signal that can be sent to processes; core/init.lua
This requires lspawn r34 (changeset 85eadda7da2a).
Diffstat (limited to 'core/init.lua')
-rw-r--r--core/init.lua4
1 files changed, 3 insertions, 1 deletions
diff --git a/core/init.lua b/core/init.lua
index 591c67d1..09219f48 100644
--- a/core/init.lua
+++ b/core/init.lua
@@ -205,6 +205,8 @@ function spawn_proc:write(...) end
function spawn_proc:close() end
---
--- Kills running process *spawn_proc*.
+-- Kills running process *spawn_proc*, or sends it Unix signal *signal*.
+-- @param signal Optional Unix signal to send to *spawn_proc*. The default value
+-- is 9 (`SIGKILL`), which kills the process.
function spawn_proc:kill() end
]]