Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

clarify behavior of multipass shell in short_help and description #3649

Merged
merged 3 commits into from
Aug 29, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions src/client/cli/cmd/shell.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,9 @@ mp::ReturnCode cmd::Shell::run(mp::ArgParser* parser)

if (parser->isSet("timeout"))
{
timer = cmd::make_timer(parser->value("timeout").toInt(), nullptr, cerr,
timer = cmd::make_timer(parser->value("timeout").toInt(),
nullptr,
cerr,
"Timed out waiting for instance to start.");
timer->start();
}
Expand Down Expand Up @@ -108,7 +110,10 @@ mp::ReturnCode cmd::Shell::run(mp::ArgParser* parser)
return return_code;
}

std::string cmd::Shell::name() const { return "shell"; }
std::string cmd::Shell::name() const
{
return "shell";
}

std::vector<std::string> cmd::Shell::aliases() const
{
Expand All @@ -117,12 +122,13 @@ std::vector<std::string> cmd::Shell::aliases() const

QString cmd::Shell::short_help() const
{
return QStringLiteral("Open a shell on a running instance");
return QStringLiteral("Open a shell on an instance");
}

QString cmd::Shell::description() const
{
return QStringLiteral("Open a shell prompt on the instance.");
return QStringLiteral(
"Open a shell prompt on the instance. If the instance is not running, it will be started automatically.");
}

mp::ParseCode cmd::Shell::parse_args(mp::ArgParser* parser)
Expand Down
Loading