Skip to content

Commit b033cfd

Browse files
docs: clarify usage message for runtime commands (#1)
Signed-off-by: federicobozzini <federico.bozzini@gmail.com>
1 parent dc9110f commit b033cfd

5 files changed

Lines changed: 5 additions & 5 deletions

File tree

cmd/remoteproc-runtime/create.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ var (
1111
)
1212

1313
var createCmd = &cobra.Command{
14-
Use: "create <ID>",
14+
Use: "create <container-id>",
1515
Short: "Create a new container from an OCI bundle",
1616
Args: cobra.ExactArgs(1),
1717
RunE: func(cmd *cobra.Command, args []string) error {

cmd/remoteproc-runtime/delete.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import (
88
var forceDelete bool
99

1010
var deleteCmd = &cobra.Command{
11-
Use: "delete <ID>",
11+
Use: "delete <container-id>",
1212
Short: "Delete a container",
1313
Long: "Delete a container. Use --force to delete a running container.",
1414
Args: cobra.ExactArgs(1),

cmd/remoteproc-runtime/kill.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import (
1010
)
1111

1212
var killCmd = &cobra.Command{
13-
Use: "kill <ID> [SIGNAL]",
13+
Use: "kill <container-id> [SIGNAL]",
1414
Short: "Send a signal to the container process",
1515
Long: "Send a signal to the container process. Supported signals: TERM (15), KILL (9), INT (2). Default is TERM.",
1616
Args: cobra.RangeArgs(1, 2),

cmd/remoteproc-runtime/start.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import (
66
)
77

88
var startCmd = &cobra.Command{
9-
Use: "start <ID>",
9+
Use: "start <container-id>",
1010
Short: "Start an existing container",
1111
Args: cobra.ExactArgs(1),
1212
RunE: func(cmd *cobra.Command, args []string) error {

cmd/remoteproc-runtime/state.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import (
99
)
1010

1111
var stateCmd = &cobra.Command{
12-
Use: "state <ID>",
12+
Use: "state <container-id>",
1313
Short: "Get the state of a container",
1414
Args: cobra.ExactArgs(1),
1515
RunE: func(cmd *cobra.Command, args []string) error {

0 commit comments

Comments
 (0)