toolshed/docker-cli
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add godoc-style docstrings to Cmd... methods

Browse Source 
Signed-off-by: Peggy Li <peggyli.224@gmail.com>
Upstream-commit: b5d0380108dde9e96d51bb01821860a0799dee0d
Component: engine
This commit is contained in:
Peggy Li
2015-03-25 10:34:41 -07:00
parent a2c5155c6a
commit ef0a4fa398
41 changed files with 152 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
components/engine/api/client/stop.go
View File

@ -9,6 +9,11 @@ import (
"github.com/docker/docker/utils"
)
// CmdStop stops one or more running containers.
//
// A running container is stopped by first sending SIGTERM and then SIGKILL if the container fails to stop within a grace period (the default is 10 seconds).
//
// Usage: docker stop [OPTIONS] CONTAINER [CONTAINER...]
func (cli *DockerCli) CmdStop(args ...string) error {
cmd := cli.Subcmd("stop", "CONTAINER [CONTAINER...]", "Stop a running container by sending SIGTERM and then SIGKILL after a\ngrace period", true)
nSeconds := cmd.Int([]string{"t", "-time"}, 10, "Seconds to wait for stop before killing it")