Improvement for docker subcommand's help messages

Wen Cheng Ma · Wen Cheng Ma · commit d7dc439623ff · 2016-01-01T12:27:28.000+08:00
Signed-off-by: Wen Cheng Ma &lt;wenchma@cn.ibm.com&gt;
diff --git a/docs/reference/commandline/ps.md b/docs/reference/commandline/ps.md
@@ -15,7 +15,15 @@ parent = "smn_cli"
     List containers
 
       -a, --all             Show all containers (default shows just running)
-      -f, --filter=[]       Filter output based on conditions provided
+      -f, --filter=[]       Filter output based on these conditions:
+                            - exited=<int> an exit code of <int>
+                            - label=<key> or label=<key>=<value>
+                            - status=(created|restarting|running|paused|exited)
+                            - name=<string> a container's name
+                            - id=<ID> a container's ID
+                            - before=(<container-name>|<container-id>)
+                            - since=(<container-name>|<container-id>)
+                            - ancestor=(<image-name>[:tag]|<image-id>|<image@digest>) - containers created from an image or a descendant.
       --format=[]           Pretty-print containers using a Go template
       --help                Print usage
       -l, --latest          Show the latest created container (includes all states)
diff --git a/man/docker-ps.1.md b/man/docker-ps.1.md
@@ -26,16 +26,15 @@ the running containers.
    Show all containers. Only running containers are shown by default. The default is *false*.
 
 **-f**, **--filter**=[]
-   Provide filter values. Valid filters:
-                          exited=<int> - containers with exit code of <int>
-                          label=<key> or label=<key>=<value>
-                          status=(created|restarting|running|paused|exited)
-                          name=<string> - container's name
-                          id=<ID> - container's ID
-                          before=(<container-name>|<container-id>)
-                          since=(<container-name>|<container-id>)
-                          ancestor=(<image-name>[:tag]|<image-id>|<image@digest>) - filters containers that were
-                          created from the given image or a descendant.
+   Filter output based on these conditions:
+   - exited=<int> an exit code of <int>
+   - label=<key> or label=<key>=<value>
+   - status=(created|restarting|running|paused|exited)
+   - name=<string> a container's name
+   - id=<ID> a container's ID
+   - before=(<container-name>|<container-id>)
+   - since=(<container-name>|<container-id>)
+   - ancestor=(<image-name>[:tag]|<image-id>|<image@digest>) - containers created from an image or a descendant.
 
 **--format**="*TEMPLATE*"
    Pretty-print containers using a Go template.
diff --git a/pkg/mflag/flag.go b/pkg/mflag/flag.go
@@ -571,10 +571,7 @@ func (fs *FlagSet) PrintDefaults() {
 				format := "  -%s=%s"
 				fmt.Fprintf(writer, format, strings.Join(names, ", -"), val)
 			}
-			for i, line := range strings.Split(flag.Usage, "\n") {
-				if i != 0 {
-					line = "  " + line
-				}
+			for _, line := range strings.Split(flag.Usage, "\n") {
 				fmt.Fprintln(writer, "\t", line)
 			}
 		}
diff --git a/runconfig/parse.go b/runconfig/parse.go
@@ -104,7 +104,7 @@ func Parse(cmd *flag.FlagSet, args []string) (*container.Config, *container.Host
 		flCpusetMems        = cmd.String([]string{"-cpuset-mems"}, "", "MEMs in which to allow execution (0-3, 0,1)")
 		flBlkioWeight       = cmd.Uint16([]string{"-blkio-weight"}, 0, "Block IO (relative weight), between 10 and 1000")
 		flSwappiness        = cmd.Int64([]string{"-memory-swappiness"}, -1, "Tune container memory swappiness (0 to 100)")
-		flNetMode           = cmd.String([]string{"-net"}, "default", "Set the Network for the container")
+		flNetMode           = cmd.String([]string{"-net"}, "default", "Connect a container to a network")
 		flMacAddress        = cmd.String([]string{"-mac-address"}, "", "Container MAC address (e.g. 92:d0:c6:0a:29:33)")
 		flIpcMode           = cmd.String([]string{"-ipc"}, "", "IPC namespace to use")
 		flRestartPolicy     = cmd.String([]string{"-restart"}, "no", "Restart policy to apply when a container exits")

Original file line number	Diff line number	Diff line change
`@@ -571,10 +571,7 @@ func (fs *FlagSet) PrintDefaults() {`
`571`	`571`	`format := " -%s=%s"`
`572`	`572`	`fmt.Fprintf(writer, format, strings.Join(names, ", -"), val)`
`573`	`573`	`}`
`574`		`- for i, line := range strings.Split(flag.Usage, "\n") {`
`575`		`- if i != 0 {`
`576`		`- line = " " + line`
`577`		`- }`
	`574`	`+ for _, line := range strings.Split(flag.Usage, "\n") {`
`578`	`575`	`fmt.Fprintln(writer, "\t", line)`
`579`	`576`	`}`
`580`	`577`	`}`