pkg/tool/exec: document how Run.cmd works with string versus list

In particular, that the string form is only meant for basic use cases, and the list form is necessary if any arguments must contain whitespace. If users continue to get confused or bitten by its behavior, we can later deprecate it in favor of the list form, teaching `cue fix` to rewrite existing code. For now, we continue to support the string form with the better docs, as doing anything else right away seems a bit premature. Fixes #3238. Signed-off-by: Daniel Martí <[email protected]> Change-Id: I8e85aa75658bc9577647d993f82a54dca844e46d Reviewed-on: https://review.gerrithub.io/c/cue-lang/cue/+/1197453 Reviewed-by: Roger Peppe <[email protected]> Unity-Result: CUE porcuepine <[email protected]> TryBot-Result: CUEcueckoo <[email protected]>
cue-lang · Jul 9, 2024 · 7e1f140 · 7e1f140
1 parent f6be8a8
commit 7e1f140
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/pkg/tool/exec/exec.cue b/pkg/tool/exec/exec.cue
@@ -19,6 +19,8 @@ Run: {
 	$id: *"tool/exec.Run" | "exec" // exec for backwards compatibility
 
 	// cmd is the command to run.
+	// Simple commands can use a string, which is split by white space characters.
+	// If any arguments include white space, 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