kata-ctl: improve command descriptions for consistency

This change improves the command descriptions for kata-ctl and can avoid certain confusions in command functionality.

Fixes #5411

Signed-off-by: Tingzhou Yuan <tzyuan15@bu.edu>
This commit is contained in:
Tingzhou Yuan 2022-10-13 02:53:06 +00:00
parent d3ee8d9f1b
commit 70676d4a99

View File

@ -16,7 +16,7 @@ pub struct KataCtlCli {
#[derive(Debug, Subcommand)] #[derive(Debug, Subcommand)]
pub enum Commands { pub enum Commands {
/// Tests if system can run Kata Containers /// Test if system can run Kata Containers
Check(CheckArgument), Check(CheckArgument),
/// Directly assign a volume to Kata Containers to manage /// Directly assign a volume to Kata Containers to manage
@ -25,13 +25,13 @@ pub enum Commands {
/// Display settings /// Display settings
Env, Env,
/// Enter into guest by debug console /// Enter into guest VM by debug console
Exec, Exec,
/// Manage vm factory /// Manage VM factory
Factory, Factory,
/// Manages iptables /// Manage guest VM iptables
Iptables(IptablesCommand), Iptables(IptablesCommand),
/// Gather metrics associated with infrastructure used to run a sandbox /// Gather metrics associated with infrastructure used to run a sandbox
@ -50,10 +50,10 @@ pub struct CheckArgument {
#[derive(Debug, Subcommand)] #[derive(Debug, Subcommand)]
pub enum CheckSubCommand { pub enum CheckSubCommand {
/// Runs all checks /// Run all checks
All, All,
/// Runs all checks but excluding network checks. /// Run all checks but excluding network checks.
NoNetworkChecks, NoNetworkChecks,
/// Only compare the current and latest available versions /// Only compare the current and latest available versions