From 124d3a20a6efe24b0d887674891c63b5aba42b61 Mon Sep 17 00:00:00 2001
From: Alex Rodriguez <alexrodriguez@ibm.com>
Date: Mon, 30 Oct 2023 08:32:30 -0700
Subject: [PATCH] Sync ops.md, update CLI --help output to be consistent in
 descriptions

Signed-off-by: Alex Rodriguez <alexrodriguez@ibm.com>
---
 cmd/containerd-stress/main.go  |  5 +++++
 cmd/containerd/command/main.go |  8 ++++++++
 cmd/ctr/app/main.go            |  8 ++++++++
 docs/ops.md                    | 16 ++++++++--------
 4 files changed, 29 insertions(+), 8 deletions(-)

diff --git a/cmd/containerd-stress/main.go b/cmd/containerd-stress/main.go
index af36c1850..3d69d4a67 100644
--- a/cmd/containerd-stress/main.go
+++ b/cmd/containerd-stress/main.go
@@ -62,6 +62,11 @@ func init() {
 	if err := setRlimit(); err != nil {
 		panic(err)
 	}
+
+	cli.HelpFlag = cli.BoolFlag{
+		Name:  "help, h",
+		Usage: "Show help",
+	}
 }
 
 type worker interface {
diff --git a/cmd/containerd/command/main.go b/cmd/containerd/command/main.go
index 88aa233e8..69e59f416 100644
--- a/cmd/containerd/command/main.go
+++ b/cmd/containerd/command/main.go
@@ -57,6 +57,14 @@ func init() {
 	cli.VersionPrinter = func(c *cli.Context) {
 		fmt.Println(c.App.Name, version.Package, c.App.Version, version.Revision)
 	}
+	cli.VersionFlag = cli.BoolFlag{
+		Name:  "version, v",
+		Usage: "Print the version",
+	}
+	cli.HelpFlag = cli.BoolFlag{
+		Name:  "help, h",
+		Usage: "Show help",
+	}
 }
 
 // App returns a *cli.App instance.
diff --git a/cmd/ctr/app/main.go b/cmd/ctr/app/main.go
index 6def24047..e07e87857 100644
--- a/cmd/ctr/app/main.go
+++ b/cmd/ctr/app/main.go
@@ -55,6 +55,14 @@ func init() {
 	cli.VersionPrinter = func(c *cli.Context) {
 		fmt.Println(c.App.Name, version.Package, c.App.Version)
 	}
+	cli.VersionFlag = cli.BoolFlag{
+		Name:  "version, v",
+		Usage: "Print the version",
+	}
+	cli.HelpFlag = cli.BoolFlag{
+		Name:  "help, h",
+		Usage: "Show help",
+	}
 }
 
 // New returns a *cli.App instance.
diff --git a/docs/ops.md b/docs/ops.md
index db30afb23..a7faf0759 100644
--- a/docs/ops.md
+++ b/docs/ops.md
@@ -35,19 +35,19 @@ generate the default configuration for containerd. The output of that command
 can be used and modified as necessary as a custom configuration.
 
 COMMANDS:
-   config    information on the containerd config
-   publish   binary to publish events to containerd
-   oci-hook  provides a base for OCI runtime hooks to allow arguments to be injected.
+   config    Information on the containerd config
+   publish   Binary to publish events to containerd
+   oci-hook  Provides a base for OCI runtime hooks to allow arguments to be injected.
    help, h   Shows a list of commands or help for one command
 
 GLOBAL OPTIONS:
-   --config value, -c value     path to the configuration file (default: "/etc/containerd/config.toml")
-   --log-level value, -l value  set the logging level [trace, debug, info, warn, error, fatal, panic]
-   --address value, -a value    address for containerd's GRPC server
+   --config value, -c value     Path to the configuration file (default: "/etc/containerd/config.toml")
+   --log-level value, -l value  Set the logging level [trace, debug, info, warn, error, fatal, panic]
+   --address value, -a value    Address for containerd's GRPC server
    --root value                 containerd root directory
    --state value                containerd state directory
-   --help, -h                   show help
-   --version, -v                print the version
+   --help, -h                   Show help
+   --version, -v                Print the version
 
 ```