Browse Source

Merge pull request #2432 from SvenDowideit/doc-stop-kill-details

IRC: add SIGTERM and SIGKILL details to docker stop and kill docco
Victor Vieux 11 years ago
parent
commit
4b8a176ee0
2 changed files with 8 additions and 4 deletions
  1. 2 2
      commands.go
  2. 6 2
      docs/sources/commandline/cli.rst

+ 2 - 2
commands.go

@@ -491,7 +491,7 @@ func (cli *DockerCli) CmdInfo(args ...string) error {
 }
 }
 
 
 func (cli *DockerCli) CmdStop(args ...string) error {
 func (cli *DockerCli) CmdStop(args ...string) error {
-	cmd := Subcmd("stop", "[OPTIONS] CONTAINER [CONTAINER...]", "Stop a running container")
+	cmd := Subcmd("stop", "[OPTIONS] CONTAINER [CONTAINER...]", "Stop a running container (Send SIGTERM, and then SIGKILL after grace period)")
 	nSeconds := cmd.Int("t", 10, "Number of seconds to wait for the container to stop before killing it.")
 	nSeconds := cmd.Int("t", 10, "Number of seconds to wait for the container to stop before killing it.")
 	if err := cmd.Parse(args); err != nil {
 	if err := cmd.Parse(args); err != nil {
 		return nil
 		return nil
@@ -876,7 +876,7 @@ func (cli *DockerCli) CmdRm(args ...string) error {
 
 
 // 'docker kill NAME' kills a running container
 // 'docker kill NAME' kills a running container
 func (cli *DockerCli) CmdKill(args ...string) error {
 func (cli *DockerCli) CmdKill(args ...string) error {
-	cmd := Subcmd("kill", "CONTAINER [CONTAINER...]", "Kill a running container")
+	cmd := Subcmd("kill", "CONTAINER [CONTAINER...]", "Kill a running container (send SIGKILL)")
 	if err := cmd.Parse(args); err != nil {
 	if err := cmd.Parse(args); err != nil {
 		return nil
 		return nil
 	}
 	}

+ 6 - 2
docs/sources/commandline/cli.rst

@@ -404,7 +404,9 @@ Insert file from github
 
 
     Usage: docker kill CONTAINER [CONTAINER...]
     Usage: docker kill CONTAINER [CONTAINER...]
 
 
-    Kill a running container
+    Kill a running container (Send SIGKILL)
+    
+The main process inside the container will be sent SIGKILL.
 
 
 .. _cli_login:
 .. _cli_login:
 
 
@@ -707,9 +709,11 @@ to the newly created container.
 
 
     Usage: docker stop [OPTIONS] CONTAINER [CONTAINER...]
     Usage: docker stop [OPTIONS] CONTAINER [CONTAINER...]
 
 
-    Stop a running container
+    Stop a running container (Send SIGTERM, and then SIGKILL after grace period)
 
 
       -t=10: Number of seconds to wait for the container to stop before killing it.
       -t=10: Number of seconds to wait for the container to stop before killing it.
+      
+The main process inside the container will receive SIGTERM, and after a grace period, SIGKILL
 
 
 .. _cli_tag:
 .. _cli_tag: