docs: Correct uv.spawn `options.args` docs about the first argument #674

squeek502 · 2023-09-02T09:47:36Z

This was left over from the libuv docs, but the luv bindings handle this differently and options.args should only include the command arguments, not the command name itself.

See #673 (comment)

Example from our tests:

luv/tests/test-process.lua

Lines 14 to 31 in dcd1a1c

    
           if isWindows then 
        
             cmd = "cmd.exe" 
        
             args = {"/c", "echo "..input} 
        
             expectedOutput = input .. "\r\n" 
        
           else 
        
             cmd = "echo" 
        
             args = {input} 
        
             expectedOutput = input .. "\n" 
        
           end 
        
           local handle, pid 
        
           handle, pid = uv.spawn(cmd, { 
        
             args = args, 
        
             stdio = {nil, stdout}, 
        
           }, expect(function (code, signal) 
        
             p("exit", {code=code, signal=signal}) 
        
             uv.close(handle) 
        
           end))

This was left over from the libuv docs, but the luv bindings handle this differently and `options.args` should *only* include the command arguments, not the command name itself.

zhaozg · 2023-09-02T11:46:23Z

docs.md

-  errors. (See `options.verbatim` below for Windows.)
+  - `options.args` - Command line arguments as a list of strings. The first
+  string should *not* be the path to the program, since that is already
+  provided via `path`. On Windows, this uses CreateProcess which concatenates


provided via path by luv, this is slightly different with libuv.

I think it's okay to leave this out because these are the luv docs, so it should be implied.

docs: Correct uv.spawn options.args docs about the first argument

e42f94a

This was left over from the libuv docs, but the luv bindings handle this differently and `options.args` should *only* include the command arguments, not the command name itself.

zhaozg approved these changes Sep 2, 2023

View reviewed changes

zhaozg reviewed Sep 2, 2023

View reviewed changes

squeek502 merged commit 045bf29 into luvit:master Sep 2, 2023
13 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Correct uv.spawn `options.args` docs about the first argument #674

docs: Correct uv.spawn `options.args` docs about the first argument #674

squeek502 commented Sep 2, 2023 •

edited

Loading

zhaozg Sep 2, 2023

squeek502 Sep 2, 2023

	if isWindows then
	cmd = "cmd.exe"
	args = {"/c", "echo "..input}
	expectedOutput = input .. "\r\n"
	else
	cmd = "echo"
	args = {input}
	expectedOutput = input .. "\n"
	end

	local handle, pid
	handle, pid = uv.spawn(cmd, {
	args = args,
	stdio = {nil, stdout},
	}, expect(function (code, signal)
	p("exit", {code=code, signal=signal})
	uv.close(handle)
	end))

docs: Correct uv.spawn options.args docs about the first argument #674

docs: Correct uv.spawn options.args docs about the first argument #674

Conversation

squeek502 commented Sep 2, 2023 • edited Loading

zhaozg Sep 2, 2023

Choose a reason for hiding this comment

squeek502 Sep 2, 2023

Choose a reason for hiding this comment

docs: Correct uv.spawn `options.args` docs about the first argument #674

docs: Correct uv.spawn `options.args` docs about the first argument #674

squeek502 commented Sep 2, 2023 •

edited

Loading