Merge pull request #877 from rajasec/readme-update

hqhq · hqhq · commit ab10b6068b3f · 2016-06-06T19:16:54.000+08:00
Updating README for starting the container
diff --git a/README.md b/README.md
@@ -65,11 +65,11 @@ You can also run specific test cases by:
 
 ### Using:
 
-To run a container with the id "test", execute `runc start` with the containers id as arg one 
+To run a container with the id "test", execute `runc run` with the containers id as arg one 
 in the bundle's root directory:
 
 ```bash
-runc start test
+runc run test
 / $ ps
 PID   USER     COMMAND
 1     daemon   sh
@@ -96,9 +96,9 @@ mkdir rootfs
 docker export $(docker create busybox) | tar -C rootfs -xvf -
 ```
 * Create `config.json` by using `runc spec`.
-* Execute `runc start` and you should be placed into a shell where you can run `ps`:
+* Execute `runc run` and you should be placed into a shell where you can run `ps`:
 ```
-$ runc start test
+$ runc run test
 / # ps
 PID   USER     COMMAND
     1 root     sh
@@ -120,7 +120,7 @@ After=network.target
 [Service]
 CPUQuota=200%
 MemoryLimit=1536M
-ExecStart=/usr/local/sbin/runc start minecraft
+ExecStart=/usr/local/sbin/runc run minecraft
 Restart=on-failure
 WorkingDirectory=/containers/minecraftbuild
 
diff --git a/main.go b/main.go
@@ -37,7 +37,7 @@ The root filesystem contains the contents of the container.
 
 To start a new instance of a container:
 
-    # runc start [ -b bundle ] <container-id>
+    # runc run [ -b bundle ] <container-id>
 
 Where "<container-id>" is your name for the instance of the container that you
 are starting. The name you provide for the container instance must be unique on
diff --git a/spec.go b/spec.go
@@ -42,9 +42,9 @@ command in a new hello-world container named container1:
     tar -C rootfs -xf hello-world.tar
     runc spec
     sed -i 's;"sh";"/hello";' ` + specConfig + `
-    runc start container1
+    runc run container1
 
-In the start command above, "container1" is the name for the instance of the
+In the run command above, "container1" is the name for the instance of the
 container that you are starting. The name you provide for the container instance
 must be unique on your host.
 
diff --git a/tests/integration/README.md b/tests/integration/README.md
@@ -71,8 +71,8 @@ function teardown() {
 }
 
 @test "this is a simple test" {
-  runc start containerid
-  # "run" automatically populates $status, $output and $lines.
+  runc run containerid
+  # "The runc macro" automatically populates $status, $output and $lines.
   # Please refer to bats documentation to find out more.
   [ "$status" -eq 0 ]
 

Original file line number	Diff line number	Diff line change
`@@ -71,8 +71,8 @@ function teardown() {`
`71`	`71`	`}`
`72`	`72`
`73`	`73`	`@test "this is a simple test" {`
`74`		`- runc start containerid`
`75`		`- # "run" automatically populates $status, $output and $lines.`
	`74`	`+ runc run containerid`
	`75`	`+ # "The runc macro" automatically populates $status, $output and $lines.`
`76`	`76`	`# Please refer to bats documentation to find out more.`
`77`	`77`	`[ "$status" -eq 0 ]`
`78`	`78`