Browse code

Add build --pull and evenets --filter flags to the docs for 1.4

Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>

Sven Dowideit authored on 2015/01/07 13:23:32
Showing 10 changed files
... ...
@@ -1315,7 +1315,7 @@ func (cli *DockerCli) CmdImages(args ...string) error {
1315 1315
 	flTree := cmd.Bool([]string{"#t", "#tree", "#-tree"}, false, "Output graph in tree format")
1316 1316
 
1317 1317
 	flFilter := opts.NewListOpts(nil)
1318
-	cmd.Var(&flFilter, []string{"f", "-filter"}, "Provide filter values (i.e. 'dangling=true')")
1318
+	cmd.Var(&flFilter, []string{"f", "-filter"}, "Provide filter values (i.e., 'dangling=true')")
1319 1319
 	cmd.Require(flag.Max, 1)
1320 1320
 
1321 1321
 	utils.ParseFlags(cmd, args, true)
... ...
@@ -1754,7 +1754,7 @@ func (cli *DockerCli) CmdEvents(args ...string) error {
1754 1754
 	since := cmd.String([]string{"#since", "-since"}, "", "Show all events created since timestamp")
1755 1755
 	until := cmd.String([]string{"-until"}, "", "Stream events until this timestamp")
1756 1756
 	flFilter := opts.NewListOpts(nil)
1757
-	cmd.Var(&flFilter, []string{"f", "-filter"}, "Provide filter values (i.e. 'event=stop')")
1757
+	cmd.Var(&flFilter, []string{"f", "-filter"}, "Provide filter values (i.e., 'event=stop')")
1758 1758
 	cmd.Require(flag.Exact, 0)
1759 1759
 
1760 1760
 	utils.ParseFlags(cmd, args, true)
... ...
@@ -163,7 +163,7 @@ complete -c docker -A -f -n '__fish_seen_subcommand_from history' -a '(__fish_pr
163 163
 # images
164 164
 complete -c docker -f -n '__fish_docker_no_subcommand' -a images -d 'List images'
165 165
 complete -c docker -A -f -n '__fish_seen_subcommand_from images' -s a -l all -d 'Show all images (by default filter out the intermediate image layers)'
166
-complete -c docker -A -f -n '__fish_seen_subcommand_from images' -s f -l filter -d "Provide filter values (i.e. 'dangling=true')"
166
+complete -c docker -A -f -n '__fish_seen_subcommand_from images' -s f -l filter -d "Provide filter values (i.e., 'dangling=true')"
167 167
 complete -c docker -A -f -n '__fish_seen_subcommand_from images' -l no-trunc -d "Don't truncate output"
168 168
 complete -c docker -A -f -n '__fish_seen_subcommand_from images' -s q -l quiet -d 'Only show numeric IDs'
169 169
 complete -c docker -A -f -n '__fish_seen_subcommand_from images' -a '(__fish_print_docker_repositories)' -d "Repository"
... ...
@@ -10,6 +10,7 @@ docker-build - Build a new image from the source code at PATH
10 10
 [**-f**|**--file**[=*Dockerfile*]]
11 11
 [**--force-rm**[=*false*]]
12 12
 [**--no-cache**[=*false*]]
13
+[**--pull**[=*false*]]
13 14
 [**-q**|**--quiet**[=*false*]]
14 15
 [**--rm**[=*true*]]
15 16
 [**-t**|**--tag**[=*TAG*]]
... ...
@@ -44,6 +45,9 @@ as context.
44 44
 **--help**
45 45
   Print usage statement
46 46
 
47
+**--pull**=*true*|*false*
48
+   Always attempt to pull a newer version of the image. The default is *false*.
49
+
47 50
 **-q**, **--quiet**=*true*|*false*
48 51
    Suppress the verbose output generated by the containers. The default is *false*.
49 52
 
... ...
@@ -7,6 +7,7 @@ docker-events - Get real time events from the server
7 7
 # SYNOPSIS
8 8
 **docker events**
9 9
 [**--help**]
10
+[**-f**|**--filter**[=*[]*]]
10 11
 [**--since**[=*SINCE*]]
11 12
 [**--until**[=*UNTIL*]]
12 13
 
... ...
@@ -27,6 +28,9 @@ and Docker images will report:
27 27
 **--help**
28 28
   Print usage statement
29 29
 
30
+**-f**, **--filter**=[]
31
+   Provide filter values (i.e., 'event=stop')
32
+
30 33
 **--since**=""
31 34
    Show all events created since timestamp
32 35
 
... ...
@@ -34,7 +34,7 @@ versions.
34 34
    Show all images (by default filter out the intermediate image layers). The default is *false*.
35 35
 
36 36
 **-f**, **--filter**=[]
37
-   Provide filter values (i.e. 'dangling=true')
37
+   Provide filter values (i.e., 'dangling=true')
38 38
 
39 39
 **--help**
40 40
   Print usage statement
... ...
@@ -15,7 +15,7 @@ CONTAINER
15 15
 # DESCRIPTION
16 16
 The **docker logs** command batch-retrieves whatever logs are present for
17 17
 a container at the time of execution. This does not guarantee execution
18
-order when combined with a docker run (i.e. your run may not have generated
18
+order when combined with a docker run (i.e., your run may not have generated
19 19
 any logs at the time you execute docker logs).
20 20
 
21 21
 The **docker logs --follow** command combines commands **docker logs** and
... ...
@@ -53,7 +53,7 @@ First generate CA private and public keys:
53 53
      Email Address []:Sven@home.org.au
54 54
 
55 55
 Now that we have a CA, you can create a server key and certificate
56
-signing request (CSR). Make sure that "Common Name" (i.e. server FQDN or YOUR
56
+signing request (CSR). Make sure that "Common Name" (i.e., server FQDN or YOUR
57 57
 name) matches the hostname you will use to connect to Docker:
58 58
 
59 59
     $ openssl genrsa -out server-key.pem 2048
... ...
@@ -105,9 +105,9 @@ The first half (without the `total_` prefix) contains statistics relevant
105 105
 to the processes within the cgroup, excluding sub-cgroups. The second half
106 106
 (with the `total_` prefix) includes sub-cgroups as well.
107 107
 
108
-Some metrics are "gauges", i.e. values that can increase or decrease
108
+Some metrics are "gauges", i.e., values that can increase or decrease
109 109
 (e.g., swap, the amount of swap space used by the members of the cgroup).
110
-Some others are "counters", i.e. values that can only go up, because
110
+Some others are "counters", i.e., values that can only go up, because
111 111
 they represent occurrences of a specific event (e.g., pgfault, which
112 112
 indicates the number of page faults which happened since the creation of
113 113
 the cgroup; this number can never decrease).
... ...
@@ -211,7 +211,7 @@ For each container, you will find a pseudo-file `cpuacct.stat`,
211 211
 containing the CPU usage accumulated by the processes of the container,
212 212
 broken down between `user` and `system` time. If you're not familiar
213 213
 with the distinction, `user` is the time during which the processes were
214
-in direct control of the CPU (i.e. executing process code), and `system`
214
+in direct control of the CPU (i.e., executing process code), and `system`
215 215
 is the time during which the CPU was executing system calls on behalf of
216 216
 those processes.
217 217
 
... ...
@@ -366,7 +366,7 @@ Please review [*Enumerating Cgroups*](#enumerating-cgroups) to learn how to find
366 366
 the cgroup of a process running in the container of which you want to
367 367
 measure network usage. From there, you can examine the pseudo-file named
368 368
 `tasks`, which contains the PIDs that are in the
369
-control group (i.e. in the container). Pick any one of them.
369
+control group (i.e., in the container). Pick any one of them.
370 370
 
371 371
 Putting everything together, if the "short ID" of a container is held in
372 372
 the environment variable `$CID`, then you can do this:
... ...
@@ -260,7 +260,7 @@ for user-namespaces, simplifying the process of hardening containers.
260 260
 
261 261
 Docker containers are, by default, quite secure; especially if you take
262 262
 care of running your processes inside the containers as non-privileged
263
-users (i.e. non-`root`).
263
+users (i.e., non-`root`).
264 264
 
265 265
 You can add an extra layer of safety by enabling Apparmor, SELinux,
266 266
 GRSEC, or your favorite hardening solution.
... ...
@@ -479,9 +479,9 @@ To kill the container, use `docker kill`.
479 479
 
480 480
     Build a new image from the source code at PATH
481 481
 
482
-      -f, --file=""            Location of the Dockerfile to use. Default is 'Dockerfile' at the root of the build context
483 482
       --force-rm=false         Always remove intermediate containers, even after unsuccessful builds
484 483
       --no-cache=false         Do not use cache when building the image
484
+      --pull=false             Always attempt to pull a newer version of the image
485 485
       -q, --quiet=false        Suppress the verbose output generated by the containers
486 486
       --rm=true                Remove intermediate containers after a successful build
487 487
       -t, --tag=""             Repository name (and optionally a tag) to be applied to the resulting image in case of success
... ...
@@ -848,6 +848,7 @@ For example:
848 848
 
849 849
     Get real time events from the server
850 850
 
851
+      -f, --filter=[]    Provide filter values (i.e., 'event=stop')
851 852
       --since=""         Show all events created since timestamp
852 853
       --until=""         Stream events until this timestamp
853 854
 
... ...
@@ -1023,7 +1024,7 @@ To see how the `docker:latest` image was built:
1023 1023
     List images
1024 1024
 
1025 1025
       -a, --all=false      Show all images (by default filter out the intermediate image layers)
1026
-      -f, --filter=[]      Provide filter values (i.e. 'dangling=true')
1026
+      -f, --filter=[]      Provide filter values (i.e., 'dangling=true')
1027 1027
       --no-trunc=false     Don't truncate output
1028 1028
       -q, --quiet=false    Only show numeric IDs
1029 1029