Browse code

Merge pull request #6544 from mheon/sigproxy_docs

Update --sig-proxy documentation

Sven Dowideit authored on 2014/06/30 12:16:38
Showing 5 changed files
... ...
@@ -1733,7 +1733,7 @@ func (cli *DockerCli) CmdAttach(args ...string) error {
1733 1733
 	var (
1734 1734
 		cmd     = cli.Subcmd("attach", "[OPTIONS] CONTAINER", "Attach to a running container")
1735 1735
 		noStdin = cmd.Bool([]string{"#nostdin", "-no-stdin"}, false, "Do not attach stdin")
1736
-		proxy   = cmd.Bool([]string{"#sig-proxy", "-sig-proxy"}, true, "Proxify all received signal to the process (even in non-tty mode)")
1736
+		proxy   = cmd.Bool([]string{"#sig-proxy", "-sig-proxy"}, true, "Proxify received signals to the process (even in non-tty mode). SIGCHLD is not proxied")
1737 1737
 	)
1738 1738
 
1739 1739
 	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
 
... ...
@@ -181,8 +181,8 @@ default is *false*. This option is incompatible with **-d**.
181 181
 
182 182
 
183 183
 **--sig-proxy**=*true*|*false*
184
-   When set to true, proxify all received signals to the process (even in
185
-non-tty mode). The default is true.
184
+   When set to true, proxify received signals to the process (even in
185
+non-tty mode). SIGCHLD is not proxied. The default is *true*.
186 186
 
187 187
 
188 188
 **-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`)
... ...
@@ -928,7 +928,7 @@ removed before the image is removed.
928 928
       -P, --publish-all=false    Publish all exposed ports to the host interfaces
929 929
       --privileged=false         Give extended privileges to this container
930 930
       --rm=false                 Automatically remove the container when it exits (incompatible with -d)
931
-      --sig-proxy=true           Proxify all received signal to the process (even in non-tty mode)
931
+      --sig-proxy=true           Proxify received signals to the process (even in non-tty mode). SIGCHLD is not proxied.
932 932
       -t, --tty=false            Allocate a pseudo-tty
933 933
       -u, --user=""              Username or UID
934 934
       -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