Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: auto generate pouch cli/api/contributors docs via code #2996

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CONTRIBUTORS
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ Frankzhaopku <syzhao1988@126.com>
GodweiFighting <1250394994@qq.com>
Guoliang Wang <iamwgliang@gmail.com>
Haoran Lu <haoran.lu@daocloud.io>
huaihuan.zy <huaihuan.zy@alibaba-inc.com>
HusterWan <zirenwan@gmail.com>
jahentao <tzhltjh@163.com>
Jerome Tan <DevJerome@iCloud.com>
Expand Down Expand Up @@ -140,6 +141,7 @@ Zhang Zhanchun <zzchun@zju.edu.cn>
zhangyue <zy675793960@yeah.net>
zheng chen <21751032@zju.edu.cn>
zheng chen <30573528+zeppp@users.noreply.github.com>
zhijin <zhijin.zqh@alibaba-inc.com>
zhuangqh <zhuangqhc@163.com>
zhuangqh <zhuangqhc@gmail.com>
zhubingbing <1392607554@qq.com>
Expand Down
1 change: 1 addition & 0 deletions docs/api/HTTP_API.md
Original file line number Diff line number Diff line change
Expand Up @@ -2796,6 +2796,7 @@ Container configuration that depends on the host we are running on
|**CapAdd** <br>*optional*|A list of kernel capabilities to add to the container.|< string > array|
|**CapDrop** <br>*optional*|A list of kernel capabilities to drop from the container.|< string > array|
|**Cgroup** <br>*optional*|Cgroup to use for the container.|string|
|**CgroupMode** <br>*optional*|Determine the container has own cgroup namespace, valid values is host <br>`"host"` means own host cgroup namespace, default or other values will share<br>host cgroup namespace. Note cgroup namespace only take effect for kernel > 4.6|string|
|**CgroupParent** <br>*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** <br>*optional*|Initial console size, as an `[height, width]` array. (Windows only)|< integer > array|
|**ContainerIDFile** <br>*optional*|Path to a file where the container ID is written|string|
Expand Down
1 change: 1 addition & 0 deletions docs/commandline/pouch_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:]<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" (default [])
--volume-driver string set volume driver for container's volumes
--volumes-from strings set volumes from other containers, format is <container>[:mode]
-w, --workdir string Set the working directory in a container
```
Expand Down
1 change: 1 addition & 0 deletions docs/commandline/pouch_run.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:]<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" (default [])
--volume-driver string set volume driver for container's volumes
--volumes-from strings set volumes from other containers, format is <container>[:mode]
-w, --workdir string Set the working directory in a container
```
Expand Down