add docs/comments to command prep code

hashicorp · Jul 18, 2022 · a23d3ac · a23d3ac
1 parent 5944aff
commit a23d3ac
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/child/command-prep.go b/child/command-prep.go
@@ -8,6 +8,10 @@ import (
 	"strings"
 )
 
+// Evaluates the command slice for the different possible formats.
+// Returns the command slice ready to pass to exec.Command.
+// Returns a boolean 'true' if it wrapped the call in 'sh -c' so the caller
+// knows it needs to setpgid to get signal propagation.
 func CommandPrep(command []string) ([]string, bool, error) {
 	switch {
 	case len(command) == 1 && len(strings.Fields(command[0])) > 1:

diff --git a/child/command-prep_windows.go b/child/command-prep_windows.go
@@ -8,6 +8,8 @@ import (
 	"strings"
 )
 
+// Simplified command prep for windows. Only supports single or slice commands
+// and doesn't wrap anything in a shell call (so bool is always false).
 func CommandPrep(command []string) ([]string, bool, error) {
 	switch {
 	case len(command) == 1 && len(strings.Fields(command[0])) == 1: