Skip to content

Conversation

robinbrandt
Copy link
Contributor

(Don't know if this is a regression or a bug in the docs. This would be to improve the docs if it's the latter...)

This change updates the documentation to be more explicit about where to put command and arguments for shadowenv exec (and fixing some typos).

The previous documentation suggested that program arguments need to be specified after a --. But it's actually both the command name and the arguments.

The old text:

$ shadowenv exec --help
...
USAGE:
    shadowenv exec [OPTIONS] <child-argv0|child-argv> [child-argv0] [-- <child-argv>...]

ARGS:
    <child-argv0>      If the command takes no arguments, it can be passed directly as the last arugment.
    <child-argv>...    If the command requires arguments, they must all be passed after a --.

This is in contrast of how it actually works.

Bad:

$ shadowenv exec ls -- /
error: The argument '<child-argv>...' cannot be used with one or more of
  the other specified arguments

Good:

$ shadowenv exec -- ls /
Applications    cores           etc ...

This change updates the documentation to be more explicit about where to
put command and arguments.

The previous documentation suggested that program arguments need to be
specified after a `--`. But it's actually both the command name and the
arguments.

The old text:

$ shadowenv exec --help
...
USAGE:
    shadowenv exec [OPTIONS] <child-argv0|child-argv> [child-argv0] [-- <child-argv>...]

ARGS:
    <child-argv0>      If the command takes no arguments, it can be passed directly as the last arugment.
    <child-argv>...    If the command requires arguments, they must all be passed after a --.

This is in contrast of how it actually works.

Bad:

$ shadowenv exec ls -- /
error: The argument '<child-argv>...' cannot be used with one or more of
  the other specified arguments

Good:

$ shadowenv exec -- ls /
Applications    cores           etc ...
Copy link
Member

@burke burke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh yeah good catch, thanks!

@robinbrandt robinbrandt merged commit b647e68 into main Aug 1, 2025
9 checks passed
@robinbrandt robinbrandt deleted the 07-24-update_documentation_for_shadowenv_exec_ branch August 1, 2025 17:09
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.

2 participants