Browse Source

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

Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
Sven Dowideit 10 years ago
parent
commit
18a2c77435

+ 2 - 2
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")
 	flTree := cmd.Bool([]string{"#t", "#tree", "#-tree"}, false, "Output graph in tree format")
 
 
 	flFilter := opts.NewListOpts(nil)
 	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)
 	cmd.Require(flag.Max, 1)
 
 
 	utils.ParseFlags(cmd, args, true)
 	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")
 	since := cmd.String([]string{"#since", "-since"}, "", "Show all events created since timestamp")
 	until := cmd.String([]string{"-until"}, "", "Stream events until this timestamp")
 	until := cmd.String([]string{"-until"}, "", "Stream events until this timestamp")
 	flFilter := opts.NewListOpts(nil)
 	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)
 	cmd.Require(flag.Exact, 0)
 
 
 	utils.ParseFlags(cmd, args, true)
 	utils.ParseFlags(cmd, args, true)

+ 1 - 1
contrib/completion/fish/docker.fish

@@ -163,7 +163,7 @@ complete -c docker -A -f -n '__fish_seen_subcommand_from history' -a '(__fish_pr
 # images
 # images
 complete -c docker -f -n '__fish_docker_no_subcommand' -a images -d 'List 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 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' -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' -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"
 complete -c docker -A -f -n '__fish_seen_subcommand_from images' -a '(__fish_print_docker_repositories)' -d "Repository"

+ 4 - 0
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*]]
 [**-f**|**--file**[=*Dockerfile*]]
 [**--force-rm**[=*false*]]
 [**--force-rm**[=*false*]]
 [**--no-cache**[=*false*]]
 [**--no-cache**[=*false*]]
+[**--pull**[=*false*]]
 [**-q**|**--quiet**[=*false*]]
 [**-q**|**--quiet**[=*false*]]
 [**--rm**[=*true*]]
 [**--rm**[=*true*]]
 [**-t**|**--tag**[=*TAG*]]
 [**-t**|**--tag**[=*TAG*]]
@@ -44,6 +45,9 @@ as context.
 **--help**
 **--help**
   Print usage statement
   Print usage statement
 
 
+**--pull**=*true*|*false*
+   Always attempt to pull a newer version of the image. The default is *false*.
+
 **-q**, **--quiet**=*true*|*false*
 **-q**, **--quiet**=*true*|*false*
    Suppress the verbose output generated by the containers. The default is *false*.
    Suppress the verbose output generated by the containers. The default is *false*.
 
 

+ 4 - 0
docs/man/docker-events.1.md

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

+ 1 - 1
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*.
    Show all images (by default filter out the intermediate image layers). The default is *false*.
 
 
 **-f**, **--filter**=[]
 **-f**, **--filter**=[]
-   Provide filter values (i.e. 'dangling=true')
+   Provide filter values (i.e., 'dangling=true')
 
 
 **--help**
 **--help**
   Print usage statement
   Print usage statement

+ 1 - 1
docs/man/docker-logs.1.md

@@ -15,7 +15,7 @@ CONTAINER
 # DESCRIPTION
 # DESCRIPTION
 The **docker logs** command batch-retrieves whatever logs are present for
 The **docker logs** command batch-retrieves whatever logs are present for
 a container at the time of execution. This does not guarantee execution
 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).
 any logs at the time you execute docker logs).
 
 
 The **docker logs --follow** command combines commands **docker logs** and
 The **docker logs --follow** command combines commands **docker logs** and

+ 1 - 1
docs/sources/articles/https.md

@@ -53,7 +53,7 @@ First generate CA private and public keys:
      Email Address []:Sven@home.org.au
      Email Address []:Sven@home.org.au
 
 
 Now that we have a CA, you can create a server key and certificate
 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:
 name) matches the hostname you will use to connect to Docker:
 
 
     $ openssl genrsa -out server-key.pem 2048
     $ openssl genrsa -out server-key.pem 2048

+ 4 - 4
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
 to the processes within the cgroup, excluding sub-cgroups. The second half
 (with the `total_` prefix) includes sub-cgroups as well.
 (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).
 (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
 they represent occurrences of a specific event (e.g., pgfault, which
 indicates the number of page faults which happened since the creation of
 indicates the number of page faults which happened since the creation of
 the cgroup; this number can never decrease).
 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,
 containing the CPU usage accumulated by the processes of the container,
 broken down between `user` and `system` time. If you're not familiar
 broken down between `user` and `system` time. If you're not familiar
 with the distinction, `user` is the time during which the processes were
 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
 is the time during which the CPU was executing system calls on behalf of
 those processes.
 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
 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
 measure network usage. From there, you can examine the pseudo-file named
 `tasks`, which contains the PIDs that are in the
 `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
 Putting everything together, if the "short ID" of a container is held in
 the environment variable `$CID`, then you can do this:
 the environment variable `$CID`, then you can do this:

+ 1 - 1
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
 Docker containers are, by default, quite secure; especially if you take
 care of running your processes inside the containers as non-privileged
 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,
 You can add an extra layer of safety by enabling Apparmor, SELinux,
 GRSEC, or your favorite hardening solution.
 GRSEC, or your favorite hardening solution.

+ 3 - 2
docs/sources/reference/commandline/cli.md

@@ -479,9 +479,9 @@ To kill the container, use `docker kill`.
 
 
     Build a new image from the source code at PATH
     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
       --force-rm=false         Always remove intermediate containers, even after unsuccessful builds
       --no-cache=false         Do not use cache when building the image
       --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
       -q, --quiet=false        Suppress the verbose output generated by the containers
       --rm=true                Remove intermediate containers after a successful build
       --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
       -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:
 
 
     Get real time events from the server
     Get real time events from the server
 
 
+      -f, --filter=[]    Provide filter values (i.e., 'event=stop')
       --since=""         Show all events created since timestamp
       --since=""         Show all events created since timestamp
       --until=""         Stream events until this timestamp
       --until=""         Stream events until this timestamp
 
 
@@ -1023,7 +1024,7 @@ To see how the `docker:latest` image was built:
     List images
     List images
 
 
       -a, --all=false      Show all images (by default filter out the intermediate image layers)
       -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
       --no-trunc=false     Don't truncate output
       -q, --quiet=false    Only show numeric IDs
       -q, --quiet=false    Only show numeric IDs