docs: auto generate pouch cli docs via code

Signed-off-by: pouchrobot <[email protected]>
peshxx · Apr 20, 2018 · 6da761a · 6da761a
1 parent 8336084
commit 6da761a
Show file tree

Hide file tree

Showing 6 changed files with 44 additions and 32 deletions.
diff --git a/CONTRIBUTORS b/CONTRIBUTORS
@@ -19,8 +19,10 @@ Dewey-Ding <[email protected]>
 Frank Yang <[email protected]>
 frankyang <[email protected]>
 GodweiFighting <[email protected]>
+Haoran Lu <[email protected]>
 HusterWan <[email protected]>
 Jumping Qu <[email protected]>
+kun <[email protected]>
 letty <[email protected]>
 letty <[email protected]>
 letty.ll <[email protected]>
@@ -61,6 +63,7 @@ Zhang Min <[email protected]>
 Zhang Zhanchun <[email protected]>
 zheng chen <[email protected]>
 zheng chen <[email protected]>
+zhuangqh <[email protected]>
 zhubingbing <[email protected]>
 zhubingbing <[email protected]>
 zhubingbing <[email protected]>

diff --git a/docs/commandline/pouch_create.md b/docs/commandline/pouch_create.md
@@ -61,6 +61,7 @@ e1d541722d68dc5d133cca9e7bd8fd9338603e1763096c8e853522b60d11f7b9
       --pid string                   PID namespace to use
   -p, --port strings                 Set container ports mapping
       --privileged                   Give extended privileges to the container
+      --quota-id string              Specified quota id, if id < 0, it means pouchd alloc a unique quota id
       --restart string               Restart policy to apply when container exits
       --rich                         Start container in rich container mode. (default false)
       --rich-mode string             Choose one rich container mode. dumb-init(default), systemd, sbin-init
@@ -72,6 +73,7 @@ e1d541722d68dc5d133cca9e7bd8fd9338603e1763096c8e853522b60d11f7b9
   -u, --user string                  UID
       --uts string                   UTS namespace to use
   -v, --volume strings               Bind mount volumes to container, format is: [source:]<destination>[:mode], [source] can be volume or host's path, <destination> is container's path, [mode] can be "ro/rw/dr/rr/z/Z/nocopy/private/rprivate/slave/rslave/shared/rshared"
+      --volumes-from strings         set volumes from other containers, format is <container>[:mode]
   -w, --workdir string               Set the working directory in a container
 ```
 

diff --git a/docs/commandline/pouch_info.md b/docs/commandline/pouch_info.md
@@ -15,9 +15,9 @@ pouch info [OPTIONS]
 ```
 $ pouch info
 Containers: 1
-Running: 1
-Paused: 0
-Stopped: 0
+ Running: 1
+ Paused: 0
+ Stopped: 0
 Images:  0
 ID:
 Name:
@@ -33,7 +33,7 @@ Kernel Version: 3.10.0-693.17.1.el7.x86_64
 Operating System:
 OSType: linux
 Architecture:
-HTTP Proxy:
+HTTP Proxy: http://127.0.0.1:5678
 HTTPS Proxy:
 Registry: https://index.docker.io/v1/
 Experimental: false

diff --git a/docs/commandline/pouch_inspect.md b/docs/commandline/pouch_inspect.md
@@ -14,34 +14,36 @@ pouch inspect [OPTIONS] CONTAINER
 
 ```
 $ pouch inspect 08e
-{
-  "Id": "08ee444faa3c6634ecdecea26de46e8a6a16efefd9afb72eb3457320b333fc60",
-  "Created": "2017-12-04 14:48:59",
-  "Path": "",
-  "Args": null,
-  "State": {
-    "StartedAt": "0001-01-01T00:00:00Z",
-    "Status": 0,
-    "FinishedAt": "0001-01-01T00:00:00Z",
-    "Pid": 25006,
-    "ExitCode": 0,
-    "Error": ""
-  },
-  "Image": "registry.docker-cn.com/library/centos:latest",
-  "ResolvConfPath": "",
-  "HostnamePath": "",
-  "HostsPath": "",
-  "LogPath": "",
-  "Name": "08ee44",
-  "RestartCount": 0,
-  "Driver": "",
-  "MountLabel": "",
-  "ProcessLabel": "",
-  "AppArmorProfile": "",
-  "ExecIDs": null,
-  "HostConfig": null,
-  "HostRootPath": ""
-}
+[
+	{
+	  "Id": "08ee444faa3c6634ecdecea26de46e8a6a16efefd9afb72eb3457320b333fc60",
+	  "Created": "2017-12-04 14:48:59",
+	  "Path": "",
+	  "Args": null,
+	  "State": {
+		"StartedAt": "0001-01-01T00:00:00Z",
+		"Status": 0,
+		"FinishedAt": "0001-01-01T00:00:00Z",
+		"Pid": 25006,
+		"ExitCode": 0,
+		"Error": ""
+	  },
+	  "Image": "registry.docker-cn.com/library/centos:latest",
+	  "ResolvConfPath": "",
+	  "HostnamePath": "",
+	  "HostsPath": "",
+	  "LogPath": "",
+	  "Name": "08ee44",
+	  "RestartCount": 0,
+	  "Driver": "",
+	  "MountLabel": "",
+	  "ProcessLabel": "",
+	  "AppArmorProfile": "",
+	  "ExecIDs": null,
+	  "HostConfig": null,
+	  "HostRootPath": ""
+	}
+]
 ```
 
 ### Options

diff --git a/docs/commandline/pouch_run.md b/docs/commandline/pouch_run.md
@@ -76,9 +76,11 @@ crw-rw-rw-    1 root     root        1,   3 Jan  8 09:40 /dev/testnull
       --pid string                   PID namespace to use
   -p, --port strings                 Set container ports mapping
       --privileged                   Give extended privileges to the container
+      --quota-id string              Specified quota id, if id < 0, it means pouchd alloc a unique quota id
       --restart string               Restart policy to apply when container exits
       --rich                         Start container in rich container mode. (default false)
       --rich-mode string             Choose one rich container mode. dumb-init(default), systemd, sbin-init
+      --rm                           Automatically remove the container after it exits
       --runtime string               OCI runtime to use for this container
       --sche-lat-switch int          Whether to enable scheduler latency count in cpuacct
       --security-opt strings         Security Options
@@ -87,6 +89,7 @@ crw-rw-rw-    1 root     root        1,   3 Jan  8 09:40 /dev/testnull
   -u, --user string                  UID
       --uts string                   UTS namespace to use
   -v, --volume strings               Bind mount volumes to container, format is: [source:]<destination>[:mode], [source] can be volume or host's path, <destination> is container's path, [mode] can be "ro/rw/dr/rr/z/Z/nocopy/private/rprivate/slave/rslave/shared/rshared"
+      --volumes-from strings         set volumes from other containers, format is <container>[:mode]
   -w, --workdir string               Set the working directory in a container
 ```
 

diff --git a/docs/commandline/pouch_upgrade.md b/docs/commandline/pouch_upgrade.md
@@ -63,6 +63,7 @@ test1
       --pid string                   PID namespace to use
   -p, --port strings                 Set container ports mapping
       --privileged                   Give extended privileges to the container
+      --quota-id string              Specified quota id, if id < 0, it means pouchd alloc a unique quota id
       --restart string               Restart policy to apply when container exits
       --rich                         Start container in rich container mode. (default false)
       --rich-mode string             Choose one rich container mode. dumb-init(default), systemd, sbin-init
@@ -74,6 +75,7 @@ test1
   -u, --user string                  UID
       --uts string                   UTS namespace to use
   -v, --volume strings               Bind mount volumes to container, format is: [source:]<destination>[:mode], [source] can be volume or host's path, <destination> is container's path, [mode] can be "ro/rw/dr/rr/z/Z/nocopy/private/rprivate/slave/rslave/shared/rshared"
+      --volumes-from strings         set volumes from other containers, format is <container>[:mode]
   -w, --workdir string               Set the working directory in a container
 ```