From 3aba4b8df779879325dcdf7ee4e4dc825fc542e9 Mon Sep 17 00:00:00 2001 From: aarondill Date: Tue, 2 Jul 2024 00:23:09 -0500 Subject: [PATCH] docs: update docs for awesome.spawn to describe the new behavior Should this also document the default behavior on `false`? --- spawn.c | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/spawn.c b/spawn.c index 8432fb5330..4dd5839ca2 100644 --- a/spawn.c +++ b/spawn.c @@ -412,9 +412,15 @@ spawn_child_exited(pid_t pid, int status) * * @tparam string|table cmd The command to launch. * @tparam[opt=true] boolean use_sn Use startup-notification? - * @tparam[opt=false] boolean|string stdin Return a fd for stdin? - * @tparam[opt=false] boolean|string stdout Return a fd for stdout? - * @tparam[opt=false] boolean|string stderr Return a fd for stderr? + * @tparam[opt=false] boolean|string stdin Pass `true` to return a fd for stdin. + * Use `"DEV_NULL"` to redirect to /dev/null, or `"INHERIT"` to inherit the + * parent's stdin. + * @tparam[opt=false] boolean|string stdout Pass `true` to return a fd for + * stdout. Use `"DEV_NULL"` to redirect to /dev/null, or `"INHERIT"` to inherit + * the parent's stdout. + * @tparam[opt=false] boolean|string stderr Pass `true` to return a fd for + * stderr. Use `"DEV_NULL"` to redirect to /dev/null, or `"INHERIT"` to inherit + * the parent's stderr. * @tparam[opt=nil] function exit_callback Function to call on process exit. The * function arguments will be type of exit ("exit" or "signal") and the exit * code / the signal number causing process termination.