Browse code

Corrected description of --sig-proxy

Signal proxy does work only in non-TTY mode (--tty=false). Man pages and
commands should not lie about it.

Signed-off-by: Michal Minar <miminar@redhat.com>

Michal Minar authored on 2014/11/13 18:40:45
Showing 7 changed files
... ...
@@ -1867,7 +1867,7 @@ func (cli *DockerCli) CmdAttach(args ...string) error {
1867 1867
 	var (
1868 1868
 		cmd     = cli.Subcmd("attach", "CONTAINER", "Attach to a running container")
1869 1869
 		noStdin = cmd.Bool([]string{"#nostdin", "-no-stdin"}, false, "Do not attach STDIN")
1870
-		proxy   = cmd.Bool([]string{"#sig-proxy", "-sig-proxy"}, true, "Proxy all received signals to the process (even in non-TTY mode). SIGCHLD, SIGKILL, and SIGSTOP are not proxied.")
1870
+		proxy   = cmd.Bool([]string{"#sig-proxy", "-sig-proxy"}, true, "Proxy all received signals to the process (non-TTY mode only). SIGCHLD, SIGKILL, and SIGSTOP are not proxied.")
1871 1871
 	)
1872 1872
 
1873 1873
 	if err := cmd.Parse(args); err != nil {
... ...
@@ -2191,7 +2191,7 @@ func (cli *DockerCli) CmdRun(args ...string) error {
2191 2191
 	var (
2192 2192
 		flAutoRemove = cmd.Bool([]string{"#rm", "-rm"}, false, "Automatically remove the container when it exits (incompatible with -d)")
2193 2193
 		flDetach     = cmd.Bool([]string{"d", "-detach"}, false, "Detached mode: run the container in the background and print the new container ID")
2194
-		flSigProxy   = cmd.Bool([]string{"#sig-proxy", "-sig-proxy"}, true, "Proxy received signals to the process (even in non-TTY mode). SIGCHLD, SIGSTOP, and SIGKILL are not proxied.")
2194
+		flSigProxy   = cmd.Bool([]string{"#sig-proxy", "-sig-proxy"}, true, "Proxy received signals to the process (non-TTY mode only). SIGCHLD, SIGSTOP, and SIGKILL are not proxied.")
2195 2195
 		flName       = cmd.String([]string{"#name", "-name"}, "", "Assign a name to the container")
2196 2196
 		flAttach     *opts.ListOpts
2197 2197
 
... ...
@@ -67,7 +67,7 @@ complete -c docker -f -n '__fish_docker_no_subcommand' -s v -l version -d 'Print
67 67
 # attach
68 68
 complete -c docker -f -n '__fish_docker_no_subcommand' -a attach -d 'Attach to a running container'
69 69
 complete -c docker -A -f -n '__fish_seen_subcommand_from attach' -l no-stdin -d 'Do not attach stdin'
70
-complete -c docker -A -f -n '__fish_seen_subcommand_from attach' -l sig-proxy -d 'Proxify all received signal to the process (even in non-tty mode)'
70
+complete -c docker -A -f -n '__fish_seen_subcommand_from attach' -l sig-proxy -d 'Proxify all received signal to the process (non-TTY mode only)'
71 71
 complete -c docker -A -f -n '__fish_seen_subcommand_from attach' -a '(__fish_print_docker_containers running)' -d "Container"
72 72
 
73 73
 # build
... ...
@@ -237,7 +237,7 @@ complete -c docker -A -f -n '__fish_seen_subcommand_from run' -l name -d 'Assign
237 237
 complete -c docker -A -f -n '__fish_seen_subcommand_from run' -s p -l publish -d "Publish a container's port to the host (format: ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort) (use 'docker port' to see the actual mapping)"
238 238
 complete -c docker -A -f -n '__fish_seen_subcommand_from run' -l privileged -d 'Give extended privileges to this container'
239 239
 complete -c docker -A -f -n '__fish_seen_subcommand_from run' -l rm -d 'Automatically remove the container when it exits (incompatible with -d)'
240
-complete -c docker -A -f -n '__fish_seen_subcommand_from run' -l sig-proxy -d 'Proxify all received signal to the process (even in non-tty mode)'
240
+complete -c docker -A -f -n '__fish_seen_subcommand_from run' -l sig-proxy -d 'Proxify all received signal to the process (non-TTY mode only)'
241 241
 complete -c docker -A -f -n '__fish_seen_subcommand_from run' -s t -l tty -d 'Allocate a pseudo-tty'
242 242
 complete -c docker -A -f -n '__fish_seen_subcommand_from run' -s u -l user -d 'Username or UID'
243 243
 complete -c docker -A -f -n '__fish_seen_subcommand_from run' -s v -l volume -d 'Bind mount a volume (e.g. from the host: -v /host:/container, from docker: -v /container)'
... ...
@@ -25,7 +25,7 @@ the client.
25 25
    Do not attach STDIN. The default is *false*.
26 26
 
27 27
 **--sig-proxy**=*true*|*false*
28
-   Proxy all received signals to the process (even in non-TTY mode). SIGCHLD, SIGKILL, and SIGSTOP are not proxied. The default is *true*.
28
+   Proxy all received signals to the process (non-TTY mode only). SIGCHLD, SIGKILL, and SIGSTOP are not proxied. The default is *true*.
29 29
 
30 30
 # EXAMPLES
31 31
 
... ...
@@ -225,7 +225,7 @@ outside of a container on the host.
225 225
    Automatically remove the container when it exits (incompatible with -d). The default is *false*.
226 226
 
227 227
 **--sig-proxy**=*true*|*false*
228
-   Proxy received signals to the process (even in non-TTY mode). SIGCHLD, SIGSTOP, and SIGKILL are not proxied. The default is *true*.
228
+   Proxy received signals to the process (non-TTY mode only). SIGCHLD, SIGSTOP, and SIGKILL are not proxied. The default is *true*.
229 229
 
230 230
 **-t**, **--tty**=*true*|*false*
231 231
    When set to true Docker can allocate a pseudo-tty and attach to the standard
... ...
@@ -227,7 +227,7 @@ Docker supports softlinks for the Docker data directory
227 227
     Attach to a running container
228 228
 
229 229
       --no-stdin=false    Do not attach STDIN
230
-      --sig-proxy=true    Proxy all received signals to the process (even in non-TTY mode). SIGCHLD, SIGKILL, and SIGSTOP are not proxied.
230
+      --sig-proxy=true    Proxy all received signals to the process (non-TTY mode only). SIGCHLD, SIGKILL, and SIGSTOP are not proxied.
231 231
 
232 232
 The `attach` command lets you view or interact with any running container's
233 233
 primary process (`pid 1`).
... ...
@@ -1243,7 +1243,7 @@ removed before the image is removed.
1243 1243
       --privileged=false         Give extended privileges to this container
1244 1244
       --restart=""               Restart policy to apply when a container exits (no, on-failure[:max-retry], always)
1245 1245
       --rm=false                 Automatically remove the container when it exits (incompatible with -d)
1246
-      --sig-proxy=true           Proxy received signals to the process (even in non-TTY mode). SIGCHLD, SIGSTOP, and SIGKILL are not proxied.
1246
+      --sig-proxy=true           Proxy received signals to the process (non-TTY mode only). SIGCHLD, SIGSTOP, and SIGKILL are not proxied.
1247 1247
       -t, --tty=false            Allocate a pseudo-TTY
1248 1248
       -u, --user=""              Username or UID
1249 1249
       -v, --volume=[]            Bind mount a volume (e.g., from the host: -v /host:/container, from Docker: -v /container)
... ...
@@ -82,7 +82,7 @@ and pass along signals. All of that is configurable:
82 82
 
83 83
     -a=[]           : Attach to `STDIN`, `STDOUT` and/or `STDERR`
84 84
     -t=false        : Allocate a pseudo-tty
85
-    --sig-proxy=true: Proxify all received signal to the process (even in non-tty mode)
85
+    --sig-proxy=true: Proxify all received signal to the process (non-TTY mode only)
86 86
     -i=false        : Keep STDIN open even if not attached
87 87
 
88 88
 If you do not specify `-a` then Docker will [attach all standard
... ...
@@ -85,7 +85,7 @@ This will display the help text and all available flags:
85 85
     Attach to a running container
86 86
 
87 87
       --no-stdin=false: Do not attach stdin
88
-      --sig-proxy=true: Proxify all received signal to the process (even in non-tty mode)
88
+      --sig-proxy=true: Proxify all received signal to the process (non-TTY mode only)
89 89
 
90 90
 > **Note:** 
91 91
 > You can see a full list of Docker's commands