Skip to content

Commit 7d5779f

Browse files
committed
manual: list: Move description contents into OPTIONS field
The description contents in manual is for --format argument actually, see: # ./runc list --help ... OPTIONS: --format, -f select one of: table or json. The default format is table. The following will output the list of containers in json format: # runc list -f json --quiet, -q display only container IDs # This patch move above content into right place, and remove the command example which is not necessary. Suggested-by: Aleksa Sarai <[email protected]> Signed-off-by: Zhao Lei <[email protected]>
1 parent aedafa9 commit 7d5779f

File tree

2 files changed

+3
-14
lines changed

2 files changed

+3
-14
lines changed

list.go

+2-7
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import (
1616
"github.com/opencontainers/runc/libcontainer/utils"
1717
)
1818

19-
const formatOptions = `table or json`
19+
const formatOptions = `table(default) or json`
2020

2121
// containerState represents the platform agnostic pieces relating to a
2222
// running container's status and state
@@ -40,12 +40,7 @@ var listCommand = cli.Command{
4040
cli.StringFlag{
4141
Name: "format, f",
4242
Value: "",
43-
Usage: `select one of: ` + formatOptions + `.
44-
45-
The default format is table. The following will output the list of containers
46-
in json format:
47-
48-
# runc list -f json`,
43+
Usage: `select one of: ` + formatOptions,
4944
},
5045
cli.BoolFlag{
5146
Name: "quiet, q",

man/runc-list.8.md

+1-7
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,6 @@
44
# SYNOPSIS
55
runc list [command options] [arguments...]
66

7-
# DESCRIPTION
8-
The default format is table. The following will output the list of containers
9-
in json format:
10-
11-
# runc list -f json
12-
137
# OPTIONS
14-
--format, -f select one of: table or json.
8+
--format, -f select one of: table(default) or json.
159
--quiet, -q display only container IDs

0 commit comments

Comments
 (0)