From be4f4599a6d2a517e615dc1f64527a3f2ad2f683 Mon Sep 17 00:00:00 2001 From: Matthew Heon Date: Thu, 19 Jun 2014 08:57:01 -0400 Subject: [PATCH] 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 (github: mheon) --- api/client/commands.go | 2 +- docs/man/docker-attach.1.md | 4 ++-- docs/man/docker-run.1.md | 4 ++-- docs/sources/reference/commandline/cli.md | 4 ++-- runconfig/parse.go | 2 +- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/api/client/commands.go b/api/client/commands.go index 46a465f69a..ece457139d 100644 --- a/api/client/commands.go +++ b/api/client/commands.go @@ -1714,7 +1714,7 @@ func (cli *DockerCli) CmdAttach(args ...string) error { var ( cmd = cli.Subcmd("attach", "[OPTIONS] CONTAINER", "Attach to a running container") noStdin = cmd.Bool([]string{"#nostdin", "-no-stdin"}, false, "Do not attach stdin") - proxy = cmd.Bool([]string{"#sig-proxy", "-sig-proxy"}, true, "Proxify all received signal to the process (even in non-tty mode)") + proxy = cmd.Bool([]string{"#sig-proxy", "-sig-proxy"}, true, "Proxify received signals to the process (even in non-tty mode). SIGCHLD is not proxied") ) if err := cmd.Parse(args); err != nil { diff --git a/docs/man/docker-attach.1.md b/docs/man/docker-attach.1.md index 5a3b7a2856..91188aaaef 100644 --- a/docs/man/docker-attach.1.md +++ b/docs/man/docker-attach.1.md @@ -22,8 +22,8 @@ the client. When set to true, do not attach to stdin. The default is *false*. **--sig-proxy**=*true*|*false*: -When set to true, proxify all received signal to the process (even in non-tty -mode). The default is *true*. +When set to true, proxify received signals to the process (even in non-tty +mode). SIGCHLD is not proxied. The default is *true*. # EXAMPLES diff --git a/docs/man/docker-run.1.md b/docs/man/docker-run.1.md index 447d9e13c3..8c28a593af 100644 --- a/docs/man/docker-run.1.md +++ b/docs/man/docker-run.1.md @@ -179,8 +179,8 @@ default is *false*. This option is incompatible with **-d**. **--sig-proxy**=*true*|*false* - When set to true, proxify all received signals to the process (even in -non-tty mode). The default is true. + When set to true, proxify received signals to the process (even in +non-tty mode). SIGCHLD is not proxied. The default is *true*. **-t**, **-tty**=*true*|*false* diff --git a/docs/sources/reference/commandline/cli.md b/docs/sources/reference/commandline/cli.md index 47dd0a992d..ba557a6260 100644 --- a/docs/sources/reference/commandline/cli.md +++ b/docs/sources/reference/commandline/cli.md @@ -135,7 +135,7 @@ like this: Attach to a running container --no-stdin=false Do not attach stdin - --sig-proxy=true Proxify all received signal to the process (even in non-tty mode) + --sig-proxy=true Proxify received signals to the process (even in non-tty mode). SIGCHLD is not proxied. The `attach` command will allow you to view or interact with any running container, detached (`-d`) @@ -898,7 +898,7 @@ removed before the image is removed. -P, --publish-all=false Publish all exposed ports to the host interfaces --privileged=false Give extended privileges to this container --rm=false Automatically remove the container when it exits (incompatible with -d) - --sig-proxy=true Proxify all received signal to the process (even in non-tty mode) + --sig-proxy=true Proxify received signals to the process (even in non-tty mode). SIGCHLD is not proxied. -t, --tty=false Allocate a pseudo-tty -u, --user="" Username or UID -v, --volume=[] Bind mount a volume (e.g. from the host: -v /host:/container, from docker: -v /container) diff --git a/runconfig/parse.go b/runconfig/parse.go index fd3e4a50a7..b4ba3c7736 100644 --- a/runconfig/parse.go +++ b/runconfig/parse.go @@ -67,7 +67,7 @@ func parseRun(cmd *flag.FlagSet, args []string, sysInfo *sysinfo.SysInfo) (*Conf flCpuset = cmd.String([]string{"-cpuset"}, "", "CPUs in which to allow execution (0-3, 0,1)") 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:': 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.") // For documentation purpose - _ = cmd.Bool([]string{"#sig-proxy", "-sig-proxy"}, true, "Proxify all received signal to the process (even in non-tty mode)") + _ = cmd.Bool([]string{"#sig-proxy", "-sig-proxy"}, true, "Proxify received signals to the process (even in non-tty mode). SIGCHLD is not proxied.") _ = cmd.String([]string{"#name", "-name"}, "", "Assign a name to the container") )