github/containerd
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 2 Wiki Activity

Sync ops.md, update CLI --help output to be consistent in descriptions

Browse Source 
Signed-off-by: Alex Rodriguez <alexrodriguez@ibm.com>
This commit is contained in:
Alex Rodriguez 2023-10-30 08:32:30 -07:00
parent 332fbd907e
commit 124d3a20a6
No known key found for this signature in database
GPG Key ID: 932AE96711B39534
4 changed files with 29 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
cmd/containerd-stress/main.go
View File

@ -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 {

8
cmd/containerd/command/main.go
View File

@ -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.

8
cmd/ctr/app/main.go
View File

@ -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.

16
docs/ops.md
View File

@ -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
```