pkg/tool/exec: Run does not exececute shell commands

It has always been an abstraction over os/exec.Command, that is, directly calling a program with some arguments and not a shell. The top-level godoc was misleading users into thinking they could use shell syntax like pipes or redirections. While here, make the cmd docs a bit clearer as well. Signed-off-by: Daniel Martí <[email protected]> Change-Id: I8daa362deac7cb5380f39511f60908c9f13627b9 Reviewed-on: https://review.gerrithub.io/c/cue-lang/cue/+/1200524 Reviewed-by: Matthew Sackman <[email protected]> TryBot-Result: CUEcueckoo <[email protected]> Unity-Result: CUE porcuepine <[email protected]>
cue-lang · Sep 2, 2024 · 1e65cee · 1e65cee
1 parent 1440b9e
commit 1e65cee
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 6 deletions.
diff --git a/pkg/tool/exec/exec.cue b/pkg/tool/exec/exec.cue
@@ -14,13 +14,15 @@
 
 package exec
 
-// Run executes the given shell command.
+// Run executes a program with the given arguments.
 Run: {
 	$id: *"tool/exec.Run" | "exec" // exec for backwards compatibility
 
-	// cmd is the command to run.
+	// cmd is a non-empty list holding the program name to run
+	// and the arguments to be passed to it.
+	//
 	// Simple commands can use a string, which is split by white space characters.
-	// If any arguments include white space, use the list form.
+	// If any arguments include white space, or for clarity, use the list form.
 	cmd: string | [string, ...string]
 
 	// dir specifies the working directory of the command.

diff --git a/pkg/tool/exec/pkg.go b/pkg/tool/exec/pkg.go