Browse code

make cmd short short consistency and change docs

Signed-off-by: allencloud <allen.sun@daocloud.io>
(cherry picked from commit 184afb92bf0bda1f47b5e1812ee1134328e272e2)

allencloud authored on 2016/06/30 21:13:28
Showing 13 changed files
... ...
@@ -28,7 +28,7 @@ func newConnectCommand(dockerCli *client.DockerCli) *cobra.Command {
28 28
 
29 29
 	cmd := &cobra.Command{
30 30
 		Use:   "connect [OPTIONS] NETWORK CONTAINER",
31
-		Short: "Connects a container to a network",
31
+		Short: "Connect a container to a network",
32 32
 		Args:  cli.ExactArgs(2),
33 33
 		RunE: func(cmd *cobra.Command, args []string) error {
34 34
 			opts.network = args[0]
... ...
@@ -19,7 +19,7 @@ func newDisconnectCommand(dockerCli *client.DockerCli) *cobra.Command {
19 19
 
20 20
 	cmd := &cobra.Command{
21 21
 		Use:   "disconnect [OPTIONS] NETWORK CONTAINER",
22
-		Short: "Disconnects container from a network",
22
+		Short: "Disconnect a container from a network",
23 23
 		Args:  cli.ExactArgs(2),
24 24
 		RunE: func(cmd *cobra.Command, args []string) error {
25 25
 			opts.network = args[0]
... ...
@@ -19,7 +19,7 @@ func newInspectCommand(dockerCli *client.DockerCli) *cobra.Command {
19 19
 
20 20
 	cmd := &cobra.Command{
21 21
 		Use:   "inspect [OPTIONS] NETWORK [NETWORK...]",
22
-		Short: "Displays detailed information on one or more networks",
22
+		Short: "Display detailed information on one or more networks",
23 23
 		Args:  cli.RequiresMinArgs(1),
24 24
 		RunE: func(cmd *cobra.Command, args []string) error {
25 25
 			opts.names = args
... ...
@@ -27,7 +27,7 @@ func newInspectCommand(dockerCli *client.DockerCli) *cobra.Command {
27 27
 
28 28
 	cmd := &cobra.Command{
29 29
 		Use:   "inspect [OPTIONS] self|NODE [NODE...]",
30
-		Short: "Inspect a node in the swarm",
30
+		Short: "Display detailed information on one or more nodes",
31 31
 		Args:  cli.RequiresMinArgs(1),
32 32
 		RunE: func(cmd *cobra.Command, args []string) error {
33 33
 			opts.nodeIds = args
... ...
@@ -28,7 +28,7 @@ func newInspectCommand(dockerCli *client.DockerCli) *cobra.Command {
28 28
 
29 29
 	cmd := &cobra.Command{
30 30
 		Use:   "inspect [OPTIONS] SERVICE [SERVICE...]",
31
-		Short: "Inspect a service",
31
+		Short: "Display detailed information on one or more services",
32 32
 		Args:  cli.RequiresMinArgs(1),
33 33
 		RunE: func(cmd *cobra.Command, args []string) error {
34 34
 			opts.refs = args
... ...
@@ -19,7 +19,7 @@ func newInspectCommand(dockerCli *client.DockerCli) *cobra.Command {
19 19
 
20 20
 	cmd := &cobra.Command{
21 21
 		Use:   "inspect [OPTIONS] VOLUME [VOLUME...]",
22
-		Short: "Return low-level information on a volume",
22
+		Short: "Display detailed information on one or more volumes",
23 23
 		Args:  cli.RequiresMinArgs(1),
24 24
 		RunE: func(cmd *cobra.Command, args []string) error {
25 25
 			opts.names = args
... ...
@@ -538,7 +538,7 @@ __docker_networks_names() {
538 538
 __docker_network_commands() {
539 539
     local -a _docker_network_subcommands
540 540
     _docker_network_subcommands=(
541
-        "connect:Connects a container to a network"
541
+        "connect:Connect a container to a network"
542 542
         "create:Creates a new network with a name specified by the user"
543 543
         "disconnect:Disconnects a container from a network"
544 544
         "inspect:Displays detailed information on a network"
... ...
@@ -694,7 +694,7 @@ __docker_volume_commands() {
694 694
     local -a _docker_volume_subcommands
695 695
     _docker_volume_subcommands=(
696 696
         "create:Create a volume"
697
-        "inspect:Return low-level information on a volume"
697
+        "inspect:Display detailed information on one or more volumes"
698 698
         "ls:List volumes"
699 699
         "rm:Remove a volume"
700 700
     )
... ...
@@ -3460,7 +3460,7 @@ Return low-level information on the node `id`
3460 3460
 
3461 3461
 **Example request**:
3462 3462
 
3463
-      GET /node/24ifsmvkjbyhk HTTP/1.1
3463
+      GET /nodes/24ifsmvkjbyhk HTTP/1.1
3464 3464
 
3465 3465
 **Example response**:
3466 3466
 
... ...
@@ -3903,7 +3903,7 @@ Create a service
3903 3903
 
3904 3904
 **Example request**:
3905 3905
 
3906
-    POST /service/create HTTP/1.1
3906
+    POST /services/create HTTP/1.1
3907 3907
     Content-Type: application/json
3908 3908
 
3909 3909
     {
... ...
@@ -4020,13 +4020,13 @@ JSON Parameters:
4020 4020
 **Warning**: this endpoint is part of the Swarm management feature introduced in Docker 1.12, and
4021 4021
 might be subject to non backward-compatible changes.
4022 4022
 
4023
-`DELETE /service/(id or name)`
4023
+`DELETE /services/(id or name)`
4024 4024
 
4025 4025
 Stop and remove the service `id`
4026 4026
 
4027 4027
 **Example request**:
4028 4028
 
4029
-    DELETE /service/16253994b7c4 HTTP/1.1
4029
+    DELETE /services/16253994b7c4 HTTP/1.1
4030 4030
 
4031 4031
 **Example response**:
4032 4032
 
... ...
@@ -4038,18 +4038,18 @@ Stop and remove the service `id`
4038 4038
 -   **404** – no such service
4039 4039
 -   **500** – server error
4040 4040
 
4041
-### Inspect a service
4041
+### Inspect one or more services
4042 4042
 
4043 4043
 **Warning**: this endpoint is part of the Swarm management feature introduced in Docker 1.12, and
4044 4044
 might be subject to non backward-compatible changes.
4045 4045
 
4046
-`GET /service/(id or name)`
4046
+`GET /services/(id or name)`
4047 4047
 
4048 4048
 Return information on the service `id`.
4049 4049
 
4050 4050
 **Example request**:
4051 4051
 
4052
-    GET /service/1cb4dnqcyx6m66g2t538x3rxha HTTP/1.1
4052
+    GET /services/1cb4dnqcyx6m66g2t538x3rxha HTTP/1.1
4053 4053
 
4054 4054
 **Example response**:
4055 4055
 
... ...
@@ -4123,13 +4123,13 @@ Return information on the service `id`.
4123 4123
 **Warning**: this endpoint is part of the Swarm management feature introduced in Docker 1.12, and
4124 4124
 might be subject to non backward-compatible changes.
4125 4125
 
4126
-`POST /service/(id or name)/update`
4126
+`POST /services/(id or name)/update`
4127 4127
 
4128 4128
 Update the service `id`.
4129 4129
 
4130 4130
 **Example request**:
4131 4131
 
4132
-    POST /service/1cb4dnqcyx6m66g2t538x3rxha/update HTTP/1.1
4132
+    POST /services/1cb4dnqcyx6m66g2t538x3rxha/update HTTP/1.1
4133 4133
 
4134 4134
     {
4135 4135
       "Name": "top",
... ...
@@ -12,7 +12,7 @@ parent = "smn_cli"
12 12
 
13 13
     Usage:  docker network connect [OPTIONS] NETWORK CONTAINER
14 14
 
15
-    Connects a container to a network
15
+    Connect a container to a network
16 16
 
17 17
       --alias=[]         Add network-scoped alias for the container
18 18
       --help             Print usage
... ...
@@ -14,7 +14,7 @@ parent = "smn_cli"
14 14
 
15 15
     Usage: docker node inspect [OPTIONS] self|NODE [NODE...]
16 16
 
17
-    Return low-level information on a volume
17
+    Display detailed information on one or more nodes
18 18
 
19 19
       -f, --format=       Format the output using the given go template.
20 20
       --help              Print usage
... ...
@@ -15,7 +15,7 @@ parent = "smn_cli"
15 15
 ```Markdown
16 16
 Usage:	docker service inspect [OPTIONS] SERVICE [SERVICE...]
17 17
 
18
-Inspect a service
18
+Display detailed information on one or more services
19 19
 
20 20
 Options:
21 21
   -f, --format string   Format the output using the given go template
... ...
@@ -12,7 +12,7 @@ parent = "smn_cli"
12 12
 
13 13
     Usage: docker volume inspect [OPTIONS] VOLUME [VOLUME...]
14 14
 
15
-    Return low-level information on a volume
15
+    Display detailed information on one or more volumes
16 16
 
17 17
       -f, --format=       Format the output using the given go template.
18 18
       --help              Print usage
... ...
@@ -36,7 +36,7 @@ For full details on using docker volume visit Docker's online documentation.
36 36
   See **docker-volume-create(1)** for full documentation on the **create** command.
37 37
 
38 38
 **inspect**
39
-  Return low-level information on a volume
39
+  Display detailed information on one or more volumes
40 40
   See **docker-volume-inspect(1)** for full documentation on the **inspect** command.
41 41
 
42 42
 **ls**