Merge pull request #9941 from SvenDowideit/build-pull-option-docs

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

api/client/commands.go

@@ -1315,7 +1315,7 @@ func (cli *DockerCli) CmdImages(args ...string) error {
 	flTree := cmd.Bool([]string{"#t", "#tree", "#-tree"}, false, "Output graph in tree format")
 
 	flFilter := opts.NewListOpts(nil)
-	cmd.Var(&flFilter, []string{"f", "-filter"}, "Provide filter values (i.e. 'dangling=true')")
+	cmd.Var(&flFilter, []string{"f", "-filter"}, "Provide filter values (i.e., 'dangling=true')")
 	cmd.Require(flag.Max, 1)
 
 	utils.ParseFlags(cmd, args, true)
@@ -1754,7 +1754,7 @@ func (cli *DockerCli) CmdEvents(args ...string) error {
 	since := cmd.String([]string{"#since", "-since"}, "", "Show all events created since timestamp")
 	until := cmd.String([]string{"-until"}, "", "Stream events until this timestamp")
 	flFilter := opts.NewListOpts(nil)
-	cmd.Var(&flFilter, []string{"f", "-filter"}, "Provide filter values (i.e. 'event=stop')")
+	cmd.Var(&flFilter, []string{"f", "-filter"}, "Provide filter values (i.e., 'event=stop')")
 	cmd.Require(flag.Exact, 0)
 
 	utils.ParseFlags(cmd, args, true)

contrib/completion/fish/docker.fish

@@ -163,7 +163,7 @@ complete -c docker -A -f -n '__fish_seen_subcommand_from history' -a '(__fish_pr
 # images
 complete -c docker -f -n '__fish_docker_no_subcommand' -a images -d 'List images'
 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)'
-complete -c docker -A -f -n '__fish_seen_subcommand_from images' -s f -l filter -d "Provide filter values (i.e. 'dangling=true')"
+complete -c docker -A -f -n '__fish_seen_subcommand_from images' -s f -l filter -d "Provide filter values (i.e., 'dangling=true')"
 complete -c docker -A -f -n '__fish_seen_subcommand_from images' -l no-trunc -d "Don't truncate output"
 complete -c docker -A -f -n '__fish_seen_subcommand_from images' -s q -l quiet -d 'Only show numeric IDs'
 complete -c docker -A -f -n '__fish_seen_subcommand_from images' -a '(__fish_print_docker_repositories)' -d "Repository"

docs/man/docker-build.1.md

@@ -10,6 +10,7 @@ docker-build - Build a new image from the source code at PATH
 [**-f**|**--file**[=*Dockerfile*]]
 [**--force-rm**[=*false*]]
 [**--no-cache**[=*false*]]
+[**--pull**[=*false*]]
 [**-q**|**--quiet**[=*false*]]
 [**--rm**[=*true*]]
 [**-t**|**--tag**[=*TAG*]]
@@ -44,6 +45,9 @@ as context.
 **--help**
   Print usage statement
 
+**--pull**=*true*|*false*
+   Always attempt to pull a newer version of the image. The default is *false*.
+
 **-q**, **--quiet**=*true*|*false*
    Suppress the verbose output generated by the containers. The default is *false*.
 

docs/man/docker-events.1.md

@@ -7,6 +7,7 @@ docker-events - Get real time events from the server
 # SYNOPSIS
 **docker events**
 [**--help**]
+[**-f**|**--filter**[=*[]*]]
 [**--since**[=*SINCE*]]
 [**--until**[=*UNTIL*]]
 
@@ -27,6 +28,9 @@ and Docker images will report:
 **--help**
   Print usage statement
 
+**-f**, **--filter**=[]
+   Provide filter values (i.e., 'event=stop')
+
 **--since**=""
    Show all events created since timestamp
 

docs/man/docker-images.1.md

@@ -34,7 +34,7 @@ versions.
    Show all images (by default filter out the intermediate image layers). The default is *false*.
 
 **-f**, **--filter**=[]
-   Provide filter values (i.e. 'dangling=true')
+   Provide filter values (i.e., 'dangling=true')
 
 **--help**
   Print usage statement

docs/man/docker-logs.1.md

@@ -15,7 +15,7 @@ CONTAINER
 # DESCRIPTION
 The **docker logs** command batch-retrieves whatever logs are present for
 a container at the time of execution. This does not guarantee execution
-order when combined with a docker run (i.e. your run may not have generated
+order when combined with a docker run (i.e., your run may not have generated
 any logs at the time you execute docker logs).
 
 The **docker logs --follow** command combines commands **docker logs** and

docs/sources/articles/https.md

@@ -56,7 +56,7 @@ First generate CA private and public keys:
      Email Address []:Sven@home.org.au
 
 Now that we have a CA, you can create a server key and certificate
-signing request (CSR). Make sure that "Common Name" (i.e. server FQDN or YOUR
+signing request (CSR). Make sure that "Common Name" (i.e., server FQDN or YOUR
 name) matches the hostname you will use to connect to Docker:
 
 > **Note:** replace all instances of `$HOST` in the following example with the

docs/sources/articles/runmetrics.md

@@ -105,9 +105,9 @@ The first half (without the `total_` prefix) contains statistics relevant
 to the processes within the cgroup, excluding sub-cgroups. The second half
 (with the `total_` prefix) includes sub-cgroups as well.
 
-Some metrics are "gauges", i.e. values that can increase or decrease
+Some metrics are "gauges", i.e., values that can increase or decrease
 (e.g., swap, the amount of swap space used by the members of the cgroup).
-Some others are "counters", i.e. values that can only go up, because
+Some others are "counters", i.e., values that can only go up, because
 they represent occurrences of a specific event (e.g., pgfault, which
 indicates the number of page faults which happened since the creation of
 the cgroup; this number can never decrease).
@@ -211,7 +211,7 @@ For each container, you will find a pseudo-file `cpuacct.stat`,
 containing the CPU usage accumulated by the processes of the container,
 broken down between `user` and `system` time. If you're not familiar
 with the distinction, `user` is the time during which the processes were
-in direct control of the CPU (i.e. executing process code), and `system`
+in direct control of the CPU (i.e., executing process code), and `system`
 is the time during which the CPU was executing system calls on behalf of
 those processes.
 
@@ -366,7 +366,7 @@ Please review [*Enumerating Cgroups*](#enumerating-cgroups) to learn how to find
 the cgroup of a process running in the container of which you want to
 measure network usage. From there, you can examine the pseudo-file named
 `tasks`, which contains the PIDs that are in the
-control group (i.e. in the container). Pick any one of them.
+control group (i.e., in the container). Pick any one of them.
 
 Putting everything together, if the "short ID" of a container is held in
 the environment variable `$CID`, then you can do this:

docs/sources/articles/security.md

@@ -260,7 +260,7 @@ for user-namespaces, simplifying the process of hardening containers.
 
 Docker containers are, by default, quite secure; especially if you take
 care of running your processes inside the containers as non-privileged
-users (i.e. non-`root`).
+users (i.e., non-`root`).
 
 You can add an extra layer of safety by enabling Apparmor, SELinux,
 GRSEC, or your favorite hardening solution.

docs/sources/reference/commandline/cli.md

@@ -481,9 +481,9 @@ To kill the container, use `docker kill`.
 
     Build a new image from the source code at PATH
 
-      -f, --file=""            Location of the Dockerfile to use. Default is 'Dockerfile' at the root of the build context
       --force-rm=false         Always remove intermediate containers, even after unsuccessful builds
       --no-cache=false         Do not use cache when building the image
+      --pull=false             Always attempt to pull a newer version of the image
       -q, --quiet=false        Suppress the verbose output generated by the containers
       --rm=true                Remove intermediate containers after a successful build
       -t, --tag=""             Repository name (and optionally a tag) to be applied to the resulting image in case of success
@@ -851,6 +851,7 @@ For example:
 
     Get real time events from the server
 
+      -f, --filter=[]    Provide filter values (i.e., 'event=stop')
       --since=""         Show all events created since timestamp
       --until=""         Stream events until this timestamp
 
@@ -1035,7 +1036,7 @@ To see how the `docker:latest` image was built:
     List images
 
       -a, --all=false      Show all images (by default filter out the intermediate image layers)
-      -f, --filter=[]      Provide filter values (i.e. 'dangling=true')
+      -f, --filter=[]      Provide filter values (i.e., 'dangling=true')
       --no-trunc=false     Don't truncate output
       -q, --quiet=false    Only show numeric IDs