Browse code

updated docs & tests

Docker-DCO-1.1-Signed-off-by: Victor Vieux <vieux@docker.com> (github: vieux)

Victor Vieux authored on 2014/07/01 09:39:38
Showing 4 changed files
... ...
@@ -19,6 +19,9 @@ Using an existing container's name or ID you can create a new image.
19 19
 **-m, --message**=""
20 20
    Commit message
21 21
 
22
+**-p, --pause**=true
23
+   Pause container during commit
24
+
22 25
 # EXAMPLES
23 26
 
24 27
 ## Creating a new image from an existing container
... ...
@@ -49,6 +49,11 @@ daemon is configured to listen on.
49 49
 **New!**
50 50
 `start` and `stop` will now return 304 if the container's status is not modified
51 51
 
52
+`POST /commit`
53
+
54
+**New!**
55
+Added a `pause` parameter (default `true`) to pause the container during commit
56
+
52 57
 ## v1.12
53 58
 
54 59
 ### Full Documentation
... ...
@@ -346,7 +346,7 @@ is better to use Dockerfiles to manage your images in a documented and
346 346
 maintainable way.
347 347
 
348 348
 By default, the container being committed and its processes will be paused
349
-during the process of committing the image. This reduces the likelihood of
349
+while the image is committed. This reduces the likelihood of
350 350
 encountering data corruption during the process of creating the commit.
351 351
 If this behavior is undesired, set the 'p' option to false.
352 352
 
... ...
@@ -45,7 +45,7 @@ func TestCommitWithoutPause(t *testing.T) {
45 45
 	_, _, err = runCommandWithOutput(waitCmd)
46 46
 	errorOut(err, t, fmt.Sprintf("error thrown while waiting for container: %s", out))
47 47
 
48
-	commitCmd := exec.Command(dockerBinary, "commit", "-p", "false", cleanedContainerID)
48
+	commitCmd := exec.Command(dockerBinary, "commit", "-p=false", cleanedContainerID)
49 49
 	out, _, err = runCommandWithOutput(commitCmd)
50 50
 	errorOut(err, t, fmt.Sprintf("failed to commit container to image: %v %v", out, err))
51 51
 
... ...
@@ -58,7 +58,7 @@ func TestCommitWithoutPause(t *testing.T) {
58 58
 	deleteContainer(cleanedContainerID)
59 59
 	deleteImages(cleanedImageID)
60 60
 
61
-	logDone("commit - echo foo and commit the image")
61
+	logDone("commit - echo foo and commit the image with --pause=false")
62 62
 }
63 63
 
64 64
 func TestCommitNewFile(t *testing.T) {