aboutsummaryrefslogtreecommitdiffhomepage
path: root/core/.os.luadoc
diff options
context:
space:
mode:
authorGravatar mitchell <70453897+667e-11@users.noreply.github.com>2020-07-14 23:18:40 -0400
committerGravatar mitchell <70453897+667e-11@users.noreply.github.com>2020-07-14 23:18:40 -0400
commitec96c0bed0fdb3df98c88fc6d559fa4e483fb912 (patch)
tree7400ff98682e455158e794be5ced535f0f321e59 /core/.os.luadoc
parentf876b491aed01150ff090048e3dca4f3eb8c76f4 (diff)
Renamed os.spawn() parameter from 'argv' to 'cmd'.
There should be no confusion that it's a command line string, not a table of strings.
Diffstat (limited to 'core/.os.luadoc')
-rw-r--r--core/.os.luadoc8
1 files changed, 4 insertions, 4 deletions
diff --git a/core/.os.luadoc b/core/.os.luadoc
index 69132e6f..1908c200 100644
--- a/core/.os.luadoc
+++ b/core/.os.luadoc
@@ -6,13 +6,13 @@
module('os')
---
--- Spawns an interactive child process *argv* in a separate thread, returning
+-- Spawns an interactive child process *cmd* in a separate thread, returning
-- a handle to that process.
--- On Windows, *argv* is passed to `cmd.exe`: `%COMSPEC% /c [argv]`.
+-- On Windows, *cmd* is passed to `cmd.exe`: `%COMSPEC% /c [cmd]`.
-- At the moment, only the Windows terminal version spawns processes in the same
-- thread.
--- @param argv A command line string that contains the program's name followed
--- by arguments to pass to it. `PATH` is searched for program names.
+-- @param cmd A command line string that contains the program's name followed by
+-- arguments to pass to it. `PATH` is searched for program names.
-- @param cwd Optional current working directory (cwd) for the child
-- process. When omitted, the parent's cwd is used.
-- @param env Optional list of environment variables for the child process.