Browse Source

Merge pull request #6182 from mheon/fix_manpage_issue

Clarify manpages on docker start
James Turnbull 11 years ago
parent
commit
19ef3ff112
2 changed files with 7 additions and 0 deletions
  1. 4 0
      contrib/man/md/docker-start.1.md
  2. 3 0
      docs/sources/reference/commandline/cli.md

+ 4 - 0
contrib/man/md/docker-start.1.md

@@ -20,6 +20,10 @@ the process
 **-i**, **--interactive**=*true*|*false*
 **-i**, **--interactive**=*true*|*false*
    When true attach to container's stdin
    When true attach to container's stdin
 
 
+# NOTES
+If run on a started container, start takes no action and succeeds
+unconditionally.
+
 # HISTORY
 # HISTORY
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
 based on docker.io source material and internal work.
 based on docker.io source material and internal work.

+ 3 - 0
docs/sources/reference/commandline/cli.md

@@ -1139,6 +1139,9 @@ more details on finding shared images from the commandline.
       -a, --attach=false         Attach container's stdout/stderr and forward all signals to the process
       -a, --attach=false         Attach container's stdout/stderr and forward all signals to the process
       -i, --interactive=false    Attach container's stdin
       -i, --interactive=false    Attach container's stdin
 
 
+When run on a container that has already been started, 
+takes no action and succeeds unconditionally.
+
 ## stop
 ## stop
 
 
     Usage: docker stop [OPTIONS] CONTAINER [CONTAINER...]
     Usage: docker stop [OPTIONS] CONTAINER [CONTAINER...]