Skip to content

docs: auto generate pouch cli/api docs via code #2430

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Nov 6, 2018
Merged

docs: auto generate pouch cli/api docs via code #2430

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions CONTRIBUTORS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ Starnop <[email protected]>
steven <[email protected]>
Tao Qingyun <[email protected]>
Tardis Xu <[email protected]>
Tim Xu <[email protected]>
Tiramisu 1993 <[email protected]>
Tronegacy <[email protected]>
u2takey <[email protected]>
Expand Down
3 changes: 3 additions & 0 deletions docs/commandline/pouch_create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@ e1d541722d68dc5d133cca9e7bd8fd9338603e1763096c8e853522b60d11f7b9
--device-write-iops value Limit write rate (IO per second) from a device (default [])
--disable-network-files Disable the generation of network files(/etc/hostname, /etc/hosts and /etc/resolv.conf) for container. If true, no network files will be generated. Default false
--disk-quota strings Set disk quota for container
--dns stringArray Set DNS servers
--dns-option strings Set DNS options
--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
Expand Down
3 changes: 3 additions & 0 deletions docs/commandline/pouch_run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,9 @@ crw-rw-rw- 1 root root 1, 3 Jan 8 09:40 /dev/testnull
--device-write-iops value Limit write rate (IO per second) from a device (default [])
--disable-network-files Disable the generation of network files(/etc/hostname, /etc/hosts and /etc/resolv.conf) for container. If true, no network files will be generated. Default false
--disk-quota strings Set disk quota for container
--dns stringArray Set DNS servers
--dns-option strings Set DNS options
--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
Expand Down