docs: auto generate pouch cli docs via code

Signed-off-by: pouchrobot <pouch-dev@list.alibaba-inc.com>
AliyunContainerService · Mar 15, 2019 · 0905abb · 0905abb
1 parent fa0f000
commit 0905abb
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 4 deletions.
diff --git a/docs/commandline/pouch_create.md b/docs/commandline/pouch_create.md
@@ -43,7 +43,7 @@ e1d541722d68dc5d133cca9e7bd8fd9338603e1763096c8e853522b60d11f7b9
       --dns-search stringArray        Set DNS search domains
       --enableLxcfs                   Enable lxcfs for the container, only effective when enable-lxcfs switched on in Pouchd
       --entrypoint string             Overwrite the default ENTRYPOINT of the image
-  -e, --env stringArray               Set environment variables for container
+  -e, --env stringArray               Set environment variables for container('--env A=' means setting env A to empty, '--env B' means removing env B from container env inherited from image)
       --expose strings                Set expose container's ports
       --group-add strings             Add additional groups to join
   -h, --help                          help for create
@@ -55,6 +55,7 @@ e1d541722d68dc5d133cca9e7bd8fd9338603e1763096c8e853522b60d11f7b9
   -l, --label stringArray             Set labels for a container
       --log-driver string             Logging driver for the container (default "json-file")
       --log-opt stringArray           Log driver options
+      --mac-address string            Set mac address of container endpoint
   -m, --memory string                 Memory limit
       --memory-extra int              Represent container's memory high water mark percentage, range in [0, 100]
       --memory-force-empty-ctl int    Whether to reclaim page cache when deleting the cgroup of container

diff --git a/docs/commandline/pouch_run.md b/docs/commandline/pouch_run.md
@@ -57,7 +57,7 @@ crw-rw-rw-    1 root     root        1,   3 Jan  8 09:40 /dev/testnull
       --dns-search stringArray        Set DNS search domains
       --enableLxcfs                   Enable lxcfs for the container, only effective when enable-lxcfs switched on in Pouchd
       --entrypoint string             Overwrite the default ENTRYPOINT of the image
-  -e, --env stringArray               Set environment variables for container
+  -e, --env stringArray               Set environment variables for container('--env A=' means setting env A to empty, '--env B' means removing env B from container env inherited from image)
       --expose strings                Set expose container's ports
       --group-add strings             Add additional groups to join
   -h, --help                          help for run
@@ -69,6 +69,7 @@ crw-rw-rw-    1 root     root        1,   3 Jan  8 09:40 /dev/testnull
   -l, --label stringArray             Set labels for a container
       --log-driver string             Logging driver for the container (default "json-file")
       --log-opt stringArray           Log driver options
+      --mac-address string            Set mac address of container endpoint
   -m, --memory string                 Memory limit
       --memory-extra int              Represent container's memory high water mark percentage, range in [0, 100]
       --memory-force-empty-ctl int    Whether to reclaim page cache when deleting the cgroup of container

diff --git a/docs/commandline/pouch_update.md b/docs/commandline/pouch_update.md
@@ -38,9 +38,9 @@ $ cat /sys/fs/cgroup/memory/8649804cb63ff9713a2734d99728b9d6d5d1e4d2fbafb2b4dbdf
       --device-write-bps strings    Update write rate (bytes per second) from a device (default [])
       --device-write-iops strings   Update write rate (io per second) from a device (default [])
       --disk-quota strings          Update disk quota for container(/=10g)
-  -e, --env strings                 Set environment variables for container
+  -e, --env strings                 Update environment variables for container('--env A=' means updating env A to be empty and '--env A' means removing env A)
   -h, --help                        help for update
-  -l, --label strings               Set label for container
+  -l, --label strings               Update labels for container
   -m, --memory string               Container memory limit
       --memory-swap string          Container swap limit
       --restart string              Restart policy to apply when container exits