Skip to content

Document shell evaluation in container machine run - #2047

Open
amarkdotdev wants to merge 1 commit into
apple:mainfrom
amarkdotdev:codex/docs-machine-run-shell
Open

Document shell evaluation in container machine run#2047
amarkdotdev wants to merge 1 commit into
apple:mainfrom
amarkdotdev:codex/docs-machine-run-shell

Conversation

@amarkdotdev

Copy link
Copy Markdown

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update

Motivation and Context

container machine run joins <executable> and <arguments> and evaluates them through the guest user's shell (shell -c "$*"), including expansion, substitution, and redirection. That contract was easy to miss from --help and the docs, especially for callers expecting argv-preserving behavior like docker exec.

This update documents the shell evaluation behavior in the machine guide, command reference, and CLI help.

Fixes #1954

Testing

  • Tested locally
  • Added/updated tests
  • Added/updated docs

Docs-only change; verified wording against Sources/Plugins/MachineAPIServer/Resources/init and the existing testRunWithEnvironment / testRunCommandInShell coverage.

machine run joins the command and arguments and evaluates them with the
guest user's shell (shell -c "$*"), including expansion and substitution.
Document that contract in the CLI help and machine docs so it is not
mistaken for argv-preserving behavior.

Fixes apple#1954

Signed-off-by: amarkdotdev <amarkdotdev@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Request]: Document shell evaluation in container machine run and consider an argv-preserving mode

1 participant