From 2511cabbc33ba37e30f00a94397254dfd4e49a5e Mon Sep 17 00:00:00 2001
From: Li Ning <lining_yewu@cmss.chinamobile.com>
Date: Wed, 12 Aug 2020 17:21:53 +0800
Subject: [PATCH] virtcontainers: fix outdated example code in api document

Some type declarations were changed. The example code here is outdated
according to the example_pod_run_test.go under virtcontainers directory.
And add the imports to make where the types from clear.

Fixes: #507

Signed-off-by: Li Ning <lining_yewu@cmss.chinamobile.com>
---
 .../documentation/api/1.0/api.md              | 28 +++++++++++--------
 1 file changed, 16 insertions(+), 12 deletions(-)

diff --git a/src/runtime/virtcontainers/documentation/api/1.0/api.md b/src/runtime/virtcontainers/documentation/api/1.0/api.md
index f63f3e6d88..1ecf8a2e58 100644
--- a/src/runtime/virtcontainers/documentation/api/1.0/api.md
+++ b/src/runtime/virtcontainers/documentation/api/1.0/api.md
@@ -819,17 +819,28 @@ func ProcessListContainer(sandboxID, containerID string, options ProcessListOpti
 
 ```Go
 
+import (
+    "context"
+    "fmt"
+    "strings"
+
+    vc "github.com/kata-containers/kata-containers/src/runtime/virtcontainers"
+    "github.com/kata-containers/kata-containers/src/runtime/virtcontainers/types"
+)
+
+var containerRootfs = vc.RootFs{Target: "/var/lib/container/bundle/", Mounted: true}
+
 // This example creates and starts a single container sandbox,
 // using qemu as the hypervisor and kata as the VM agent.
 func Example_createAndStartSandbox() {
-	envs := []vc.EnvVar{
+	envs := []types.EnvVar{
 		{
 			Var:   "PATH",
 			Value: "/bin:/usr/bin:/sbin:/usr/sbin",
 		},
 	}
 
-	cmd := vc.Cmd{
+	cmd := types.Cmd{
 		Args:    strings.Split("/bin/sh", " "),
 		Envs:    envs,
 		WorkDir: "/",
@@ -844,27 +855,20 @@ func Example_createAndStartSandbox() {
 
 	// Sets the hypervisor configuration.
 	hypervisorConfig := vc.HypervisorConfig{
-		KernelPath:     "/usr/share/clear-containers/vmlinux.container",
-		ImagePath:      "/usr/share/clear-containers/clear-containers.img",
+		KernelPath:     "/usr/share/kata-containers/vmlinux.container",
+		ImagePath:      "/usr/share/kata-containers/clear-containers.img",
 		HypervisorPath: "/usr/bin/qemu-system-x86_64",
+		MemorySize:     1024,
 	}
 
 	// Use kata default values for the agent.
 	agConfig := vc.KataAgentConfig{}
 
-	// VM resources
-	vmConfig := vc.Resources{
-		VCPUs:  4,
-		Memory: 1024,
-	}
-
 	// The sandbox configuration:
 	// - One container
 	// - Hypervisor is QEMU
 	// - Agent is kata
 	sandboxConfig := vc.SandboxConfig{
-		VMConfig: vmConfig,
-
 		HypervisorType:   vc.QemuHypervisor,
 		HypervisorConfig: hypervisorConfig,