make cmd short short consistency and change docs
Signed-off-by: allencloud <allen.sun@daocloud.io>
(cherry picked from commit 184afb92bf
)
This commit is contained in:
parent
90c272a4f2
commit
49981f8327
13 changed files with 22 additions and 22 deletions
|
@ -28,7 +28,7 @@ func newConnectCommand(dockerCli *client.DockerCli) *cobra.Command {
|
|||
|
||||
cmd := &cobra.Command{
|
||||
Use: "connect [OPTIONS] NETWORK CONTAINER",
|
||||
Short: "Connects a container to a network",
|
||||
Short: "Connect a container to a network",
|
||||
Args: cli.ExactArgs(2),
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
opts.network = args[0]
|
||||
|
|
|
@ -19,7 +19,7 @@ func newDisconnectCommand(dockerCli *client.DockerCli) *cobra.Command {
|
|||
|
||||
cmd := &cobra.Command{
|
||||
Use: "disconnect [OPTIONS] NETWORK CONTAINER",
|
||||
Short: "Disconnects container from a network",
|
||||
Short: "Disconnect a container from a network",
|
||||
Args: cli.ExactArgs(2),
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
opts.network = args[0]
|
||||
|
|
|
@ -19,7 +19,7 @@ func newInspectCommand(dockerCli *client.DockerCli) *cobra.Command {
|
|||
|
||||
cmd := &cobra.Command{
|
||||
Use: "inspect [OPTIONS] NETWORK [NETWORK...]",
|
||||
Short: "Displays detailed information on one or more networks",
|
||||
Short: "Display detailed information on one or more networks",
|
||||
Args: cli.RequiresMinArgs(1),
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
opts.names = args
|
||||
|
|
|
@ -27,7 +27,7 @@ func newInspectCommand(dockerCli *client.DockerCli) *cobra.Command {
|
|||
|
||||
cmd := &cobra.Command{
|
||||
Use: "inspect [OPTIONS] self|NODE [NODE...]",
|
||||
Short: "Inspect a node in the swarm",
|
||||
Short: "Display detailed information on one or more nodes",
|
||||
Args: cli.RequiresMinArgs(1),
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
opts.nodeIds = args
|
||||
|
|
|
@ -28,7 +28,7 @@ func newInspectCommand(dockerCli *client.DockerCli) *cobra.Command {
|
|||
|
||||
cmd := &cobra.Command{
|
||||
Use: "inspect [OPTIONS] SERVICE [SERVICE...]",
|
||||
Short: "Inspect a service",
|
||||
Short: "Display detailed information on one or more services",
|
||||
Args: cli.RequiresMinArgs(1),
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
opts.refs = args
|
||||
|
|
|
@ -19,7 +19,7 @@ func newInspectCommand(dockerCli *client.DockerCli) *cobra.Command {
|
|||
|
||||
cmd := &cobra.Command{
|
||||
Use: "inspect [OPTIONS] VOLUME [VOLUME...]",
|
||||
Short: "Return low-level information on a volume",
|
||||
Short: "Display detailed information on one or more volumes",
|
||||
Args: cli.RequiresMinArgs(1),
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
opts.names = args
|
||||
|
|
|
@ -538,7 +538,7 @@ __docker_networks_names() {
|
|||
__docker_network_commands() {
|
||||
local -a _docker_network_subcommands
|
||||
_docker_network_subcommands=(
|
||||
"connect:Connects a container to a network"
|
||||
"connect:Connect a container to a network"
|
||||
"create:Creates a new network with a name specified by the user"
|
||||
"disconnect:Disconnects a container from a network"
|
||||
"inspect:Displays detailed information on a network"
|
||||
|
@ -694,7 +694,7 @@ __docker_volume_commands() {
|
|||
local -a _docker_volume_subcommands
|
||||
_docker_volume_subcommands=(
|
||||
"create:Create a volume"
|
||||
"inspect:Return low-level information on a volume"
|
||||
"inspect:Display detailed information on one or more volumes"
|
||||
"ls:List volumes"
|
||||
"rm:Remove a volume"
|
||||
)
|
||||
|
|
|
@ -3460,7 +3460,7 @@ Return low-level information on the node `id`
|
|||
|
||||
**Example request**:
|
||||
|
||||
GET /node/24ifsmvkjbyhk HTTP/1.1
|
||||
GET /nodes/24ifsmvkjbyhk HTTP/1.1
|
||||
|
||||
**Example response**:
|
||||
|
||||
|
@ -3903,7 +3903,7 @@ Create a service
|
|||
|
||||
**Example request**:
|
||||
|
||||
POST /service/create HTTP/1.1
|
||||
POST /services/create HTTP/1.1
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
|
@ -4020,13 +4020,13 @@ JSON Parameters:
|
|||
**Warning**: this endpoint is part of the Swarm management feature introduced in Docker 1.12, and
|
||||
might be subject to non backward-compatible changes.
|
||||
|
||||
`DELETE /service/(id or name)`
|
||||
`DELETE /services/(id or name)`
|
||||
|
||||
Stop and remove the service `id`
|
||||
|
||||
**Example request**:
|
||||
|
||||
DELETE /service/16253994b7c4 HTTP/1.1
|
||||
DELETE /services/16253994b7c4 HTTP/1.1
|
||||
|
||||
**Example response**:
|
||||
|
||||
|
@ -4038,18 +4038,18 @@ Stop and remove the service `id`
|
|||
- **404** – no such service
|
||||
- **500** – server error
|
||||
|
||||
### Inspect a service
|
||||
### Inspect one or more services
|
||||
|
||||
**Warning**: this endpoint is part of the Swarm management feature introduced in Docker 1.12, and
|
||||
might be subject to non backward-compatible changes.
|
||||
|
||||
`GET /service/(id or name)`
|
||||
`GET /services/(id or name)`
|
||||
|
||||
Return information on the service `id`.
|
||||
|
||||
**Example request**:
|
||||
|
||||
GET /service/1cb4dnqcyx6m66g2t538x3rxha HTTP/1.1
|
||||
GET /services/1cb4dnqcyx6m66g2t538x3rxha HTTP/1.1
|
||||
|
||||
**Example response**:
|
||||
|
||||
|
@ -4123,13 +4123,13 @@ Return information on the service `id`.
|
|||
**Warning**: this endpoint is part of the Swarm management feature introduced in Docker 1.12, and
|
||||
might be subject to non backward-compatible changes.
|
||||
|
||||
`POST /service/(id or name)/update`
|
||||
`POST /services/(id or name)/update`
|
||||
|
||||
Update the service `id`.
|
||||
|
||||
**Example request**:
|
||||
|
||||
POST /service/1cb4dnqcyx6m66g2t538x3rxha/update HTTP/1.1
|
||||
POST /services/1cb4dnqcyx6m66g2t538x3rxha/update HTTP/1.1
|
||||
|
||||
{
|
||||
"Name": "top",
|
||||
|
|
|
@ -12,7 +12,7 @@ parent = "smn_cli"
|
|||
|
||||
Usage: docker network connect [OPTIONS] NETWORK CONTAINER
|
||||
|
||||
Connects a container to a network
|
||||
Connect a container to a network
|
||||
|
||||
--alias=[] Add network-scoped alias for the container
|
||||
--help Print usage
|
||||
|
|
|
@ -14,7 +14,7 @@ parent = "smn_cli"
|
|||
|
||||
Usage: docker node inspect [OPTIONS] self|NODE [NODE...]
|
||||
|
||||
Return low-level information on a volume
|
||||
Display detailed information on one or more nodes
|
||||
|
||||
-f, --format= Format the output using the given go template.
|
||||
--help Print usage
|
||||
|
|
|
@ -15,7 +15,7 @@ parent = "smn_cli"
|
|||
```Markdown
|
||||
Usage: docker service inspect [OPTIONS] SERVICE [SERVICE...]
|
||||
|
||||
Inspect a service
|
||||
Display detailed information on one or more services
|
||||
|
||||
Options:
|
||||
-f, --format string Format the output using the given go template
|
||||
|
|
|
@ -12,7 +12,7 @@ parent = "smn_cli"
|
|||
|
||||
Usage: docker volume inspect [OPTIONS] VOLUME [VOLUME...]
|
||||
|
||||
Return low-level information on a volume
|
||||
Display detailed information on one or more volumes
|
||||
|
||||
-f, --format= Format the output using the given go template.
|
||||
--help Print usage
|
||||
|
|
|
@ -36,7 +36,7 @@ For full details on using docker volume visit Docker's online documentation.
|
|||
See **docker-volume-create(1)** for full documentation on the **create** command.
|
||||
|
||||
**inspect**
|
||||
Return low-level information on a volume
|
||||
Display detailed information on one or more volumes
|
||||
See **docker-volume-inspect(1)** for full documentation on the **inspect** command.
|
||||
|
||||
**ls**
|
||||
|
|
Loading…
Add table
Reference in a new issue