Browse code

Update documentation noting that SIGCHLD is not proxied.

Docker's --sig-proxy option sends all signals but one to a container. The
exception s SIGCHLD, which is deliberately ignored as it doesn't make sense to
send such a signal to a process in a container. Documentation updates will make
this less confusing if anyone does attempt to do this.

Docker-DCO-1.1-Signed-off-by: Matt Heon <mheon@redhat.com> (github: mheon)

Matthew Heon authored on 2014/06/19 21:57:01
Showing 5 changed files
... ...
@@ -1714,7 +1714,7 @@ func (cli *DockerCli) CmdAttach(args ...string) error {
1714 1714
 	var (
1715 1715
 		cmd     = cli.Subcmd("attach", "[OPTIONS] CONTAINER", "Attach to a running container")
1716 1716
 		noStdin = cmd.Bool([]string{"#nostdin", "-no-stdin"}, false, "Do not attach stdin")
1717
-		proxy   = cmd.Bool([]string{"#sig-proxy", "-sig-proxy"}, true, "Proxify all received signal to the process (even in non-tty mode)")
1717
+		proxy   = cmd.Bool([]string{"#sig-proxy", "-sig-proxy"}, true, "Proxify received signals to the process (even in non-tty mode). SIGCHLD is not proxied")
1718 1718
 	)
1719 1719
 
1720 1720
 	if err := cmd.Parse(args); err != nil {
... ...
@@ -22,8 +22,8 @@ the client.
22 22
 When set to true, do not attach to stdin. The default is *false*.
23 23
 
24 24
 **--sig-proxy**=*true*|*false*:
25
-When set to true, proxify all received signal to the process (even in non-tty
26
-mode). The default is *true*.
25
+When set to true, proxify received signals to the process (even in non-tty
26
+mode). SIGCHLD is not proxied. The default is *true*.
27 27
 
28 28
 # EXAMPLES
29 29
 
... ...
@@ -179,8 +179,8 @@ default is *false*. This option is incompatible with **-d**.
179 179
 
180 180
 
181 181
 **--sig-proxy**=*true*|*false*
182
-   When set to true, proxify all received signals to the process (even in
183
-non-tty mode). The default is true.
182
+   When set to true, proxify received signals to the process (even in
183
+non-tty mode). SIGCHLD is not proxied. The default is *true*.
184 184
 
185 185
 
186 186
 **-t**, **-tty**=*true*|*false*
... ...
@@ -135,7 +135,7 @@ like this:
135 135
     Attach to a running container
136 136
 
137 137
       --no-stdin=false    Do not attach stdin
138
-      --sig-proxy=true    Proxify all received signal to the process (even in non-tty mode)
138
+      --sig-proxy=true    Proxify received signals to the process (even in non-tty mode). SIGCHLD is not proxied.
139 139
 
140 140
 The `attach` command will allow you to view or
141 141
 interact with any running container, detached (`-d`)
... ...
@@ -898,7 +898,7 @@ removed before the image is removed.
898 898
       -P, --publish-all=false    Publish all exposed ports to the host interfaces
899 899
       --privileged=false         Give extended privileges to this container
900 900
       --rm=false                 Automatically remove the container when it exits (incompatible with -d)
901
-      --sig-proxy=true           Proxify all received signal to the process (even in non-tty mode)
901
+      --sig-proxy=true           Proxify received signals to the process (even in non-tty mode). SIGCHLD is not proxied.
902 902
       -t, --tty=false            Allocate a pseudo-tty
903 903
       -u, --user=""              Username or UID
904 904
       -v, --volume=[]            Bind mount a volume (e.g. from the host: -v /host:/container, from docker: -v /container)
... ...
@@ -67,7 +67,7 @@ func parseRun(cmd *flag.FlagSet, args []string, sysInfo *sysinfo.SysInfo) (*Conf
67 67
 		flCpuset          = cmd.String([]string{"-cpuset"}, "", "CPUs in which to allow execution (0-3, 0,1)")
68 68
 		flNetMode         = cmd.String([]string{"-net"}, "bridge", "Set the Network mode for the container\n'bridge': creates a new network stack for the container on the docker bridge\n'none': no networking for this container\n'container:<name|id>': reuses another container network stack\n'host': use the host network stack inside the container.  Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.")
69 69
 		// For documentation purpose
70
-		_ = cmd.Bool([]string{"#sig-proxy", "-sig-proxy"}, true, "Proxify all received signal to the process (even in non-tty mode)")
70
+		_ = cmd.Bool([]string{"#sig-proxy", "-sig-proxy"}, true, "Proxify received signals to the process (even in non-tty mode). SIGCHLD is not proxied.")
71 71
 		_ = cmd.String([]string{"#name", "-name"}, "", "Assign a name to the container")
72 72
 	)
73 73