Merge pull request #851 from pouchrobot/auto-doc-2018-03-09

docs: auto generate pouch cli/api docs via code
AliyunContainerService · Mar 9, 2018 · 19721d6 · 19721d6
2 parents 575d0b9 + dbd2b24
commit 19721d6
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 2 deletions.
diff --git a/docs/commandline/pouch_create.md b/docs/commandline/pouch_create.md
@@ -24,6 +24,7 @@ container ID: e1d541722d68dc5d133cca9e7bd8fd9338603e1763096c8e853522b60d11f7b9,
       --blkio-weight-device value    Block IO weight (relative device weight) (default [])
       --cap-add strings              Add Linux capabilities
       --cap-drop strings             Drop Linux capabilities
+      --cgroup-parent string         Optional parent cgroup for the container (default "default")
       --cpu-share int                CPU shares (relative weight)
       --cpuset-cpus string           CPUs in which to allow execution (0-3, 0,1)
       --cpuset-mems string           MEMs in which to allow execution (0-3, 0,1)

diff --git a/docs/commandline/pouch_inspect.md b/docs/commandline/pouch_inspect.md
@@ -7,7 +7,7 @@ Get the detailed information of container
 Return detailed information on Pouch container
 
 ```
-pouch inspect CONTAINER
+pouch inspect [OPTIONS] CONTAINER
 ```
 
 ### Examples
@@ -47,7 +47,8 @@ $ pouch inspect 08e
 ### Options
 
 ```
-  -h, --help   help for inspect
+  -f, --format string   Format the output using the given go template
+  -h, --help            help for inspect
 ```
 
 ### Options inherited from parent commands

diff --git a/docs/commandline/pouch_run.md b/docs/commandline/pouch_run.md
@@ -36,6 +36,7 @@ crw-rw-rw-    1 root     root        1,   3 Jan  8 09:40 /dev/testnull
       --blkio-weight-device value    Block IO weight (relative device weight) (default [])
       --cap-add strings              Add Linux capabilities
       --cap-drop strings             Drop Linux capabilities
+      --cgroup-parent string         Optional parent cgroup for the container (default "default")
       --cpu-share int                CPU shares (relative weight)
       --cpuset-cpus string           CPUs in which to allow execution (0-3, 0,1)
       --cpuset-mems string           MEMs in which to allow execution (0-3, 0,1)