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 <asarai@suse.de>
Signed-off-by: Zhao Lei <zhaolei@cn.fujitsu.com>
This commit is contained in:
Zhao Lei 2016-05-24 17:30:43 +08:00
parent aedafa9965
commit 7d5779fdee
2 changed files with 3 additions and 14 deletions

View File

@ -16,7 +16,7 @@ import (
"github.com/opencontainers/runc/libcontainer/utils"
)
const formatOptions = `table or json`
const formatOptions = `table(default) or json`
// containerState represents the platform agnostic pieces relating to a
// running container's status and state
@ -40,12 +40,7 @@ var listCommand = cli.Command{
cli.StringFlag{
Name: "format, f",
Value: "",
Usage: `select one of: ` + formatOptions + `.
The default format is table. The following will output the list of containers
in json format:
# runc list -f json`,
Usage: `select one of: ` + formatOptions,
},
cli.BoolFlag{
Name: "quiet, q",

View File

@ -4,12 +4,6 @@
# SYNOPSIS
runc list [command options] [arguments...]
# DESCRIPTION
The default format is table. The following will output the list of containers
in json format:
# runc list -f json
# OPTIONS
--format, -f select one of: table or json.
--format, -f select one of: table(default) or json.
--quiet, -q display only container IDs