Always block when run with "wezterm -e" #4535
Conversation
There was a problem hiding this comment.
An inventive approach!
I'm curious about how this impacts the --help output. Since the -e alias has now been moved to a hidden command, they need updating anyway, so please also update the doc pages for the cli; the steps are:
$ cargo build
$ ci/update-derived-files.sh
$ ci/build-docs.shWhat that does is run wezterm CMD --help for each subcommand and embed it into the docs. Then the doc build runs to reformat the docs and minimize the diff.
then amend the updated files into this PR.
I think that it would be good to explicitly mention the -e flag somewhere reasonable and discoverable in the clap help. To cover the bases, I think that means wezterm --help, wezterm-gui --help and wezterm start --help.
This is done for compatibility, as many tools assume that running a command with "$TERMINAL -e $COMMAND" blocks until the command is finished. For example some tools delete a needed file after the command returns. But since we always return immediately (in case --always-new-process is not provided and if another wezterm instance is already running), this would mean that the file is deleted before the command could do anything. Fixes wez#4523
Otherwise it is just hidden forever. We can't use the proper declarative interface, because we are faking quite some stuff for "-e", so instead we mention it explicitly in the help output.
Done, I mention |
See #4523
There is no way to do this with a declarative clap macro, so we have to fake it instead.