From f0edc950e5fa17f1bc9359cbd8734d4f774e2613 Mon Sep 17 00:00:00 2001 From: pouchrobot Date: Fri, 25 Oct 2019 11:23:03 +0000 Subject: [PATCH] docs: auto generate pouch cli/api docs via code Signed-off-by: pouchrobot --- CONTRIBUTORS | 2 ++ docs/api/HTTP_API.md | 1 + docs/commandline/pouch_create.md | 1 + docs/commandline/pouch_run.md | 1 + 4 files changed, 5 insertions(+) diff --git a/CONTRIBUTORS b/CONTRIBUTORS index 57f5c8b35..69ccc2ae5 100644 --- a/CONTRIBUTORS +++ b/CONTRIBUTORS @@ -39,6 +39,7 @@ Frankzhaopku GodweiFighting <1250394994@qq.com> Guoliang Wang Haoran Lu +huaihuan.zy HusterWan jahentao Jerome Tan @@ -140,6 +141,7 @@ Zhang Zhanchun zhangyue zheng chen <21751032@zju.edu.cn> zheng chen <30573528+zeppp@users.noreply.github.com> +zhijin zhuangqh zhuangqh zhubingbing <1392607554@qq.com> diff --git a/docs/api/HTTP_API.md b/docs/api/HTTP_API.md index f2fcfbac9..d69b9517a 100644 --- a/docs/api/HTTP_API.md +++ b/docs/api/HTTP_API.md @@ -2796,6 +2796,7 @@ Container configuration that depends on the host we are running on |**CapAdd**
*optional*|A list of kernel capabilities to add to the container.|< string > array| |**CapDrop**
*optional*|A list of kernel capabilities to drop from the container.|< string > array| |**Cgroup**
*optional*|Cgroup to use for the container.|string| +|**CgroupMode**
*optional*|Determine the container has own cgroup namespace, valid values is host
`"host"` means own host cgroup namespace, default or other values will share
host cgroup namespace. Note cgroup namespace only take effect for kernel > 4.6|string| |**CgroupParent**
*optional*|Path to `cgroups` under which the container's `cgroup` is created. If the path is not absolute, the path is considered to be relative to the `cgroups` path of the init process. Cgroups are created if they do not already exist.|string| |**ConsoleSize**
*optional*|Initial console size, as an `[height, width]` array. (Windows only)|< integer > array| |**ContainerIDFile**
*optional*|Path to a file where the container ID is written|string| diff --git a/docs/commandline/pouch_create.md b/docs/commandline/pouch_create.md index a86443f55..e8ff9c814 100644 --- a/docs/commandline/pouch_create.md +++ b/docs/commandline/pouch_create.md @@ -90,6 +90,7 @@ e1d541722d68dc5d133cca9e7bd8fd9338603e1763096c8e853522b60d11f7b9 -u, --user string UID --uts string UTS namespace to use -v, --volume volumes Bind mount volumes to container, format is: [source:][:mode], [source] can be volume or host's path, is container's path, [mode] can be "ro/rw/dr/rr/z/Z/nocopy/private/rprivate/slave/rslave/shared/rshared" (default []) + --volume-driver string set volume driver for container's volumes --volumes-from strings set volumes from other containers, format is [:mode] -w, --workdir string Set the working directory in a container ``` diff --git a/docs/commandline/pouch_run.md b/docs/commandline/pouch_run.md index 73dc4c683..154d9ad12 100644 --- a/docs/commandline/pouch_run.md +++ b/docs/commandline/pouch_run.md @@ -105,6 +105,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 volumes Bind mount volumes to container, format is: [source:][:mode], [source] can be volume or host's path, is container's path, [mode] can be "ro/rw/dr/rr/z/Z/nocopy/private/rprivate/slave/rslave/shared/rshared" (default []) + --volume-driver string set volume driver for container's volumes --volumes-from strings set volumes from other containers, format is [:mode] -w, --workdir string Set the working directory in a container ```