Skip to content

Commit

Permalink
docs: update docs for awesome.spawn to describe the new behavior
Browse files Browse the repository at this point in the history
Should this also document the default behavior on `false`?
  • Loading branch information
aarondill committed Jul 2, 2024
1 parent 2268d4c commit 3aba4b8
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions spawn.c
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 3aba4b8

Please sign in to comment.