Skip to content

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

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
Feb 15, 2019
Merged

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

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
2 changes: 1 addition & 1 deletion docs/commandline/pouch_create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ e1d541722d68dc5d133cca9e7bd8fd9338603e1763096c8e853522b60d11f7b9
### Options

```
--annotation strings Additional annotation for runtime
--annotation stringArray Additional annotation for runtime
--blkio-weight uint16 Block IO (relative weight), between 10 and 1000, or 0 to disable
--blkio-weight-device strings Block IO weight (relative device weight), need CFQ IO Scheduler enable (default [])
--cap-add strings Add Linux capabilities
Expand Down
2 changes: 1 addition & 1 deletion docs/commandline/pouch_run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ crw-rw-rw- 1 root root 1, 3 Jan 8 09:40 /dev/testnull
### Options

```
--annotation strings Additional annotation for runtime
--annotation stringArray Additional annotation for runtime
-a, --attach Attach container's STDOUT and STDERR
--blkio-weight uint16 Block IO (relative weight), between 10 and 1000, or 0 to disable
--blkio-weight-device strings Block IO weight (relative device weight), need CFQ IO Scheduler enable (default [])
Expand Down
2 changes: 2 additions & 0 deletions docs/commandline/pouch_updatedaemon.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,14 @@ $ pouch updatedaemon --debug=true
--exec-root-dir string update exec root directory for network
--fixed-cidr string update daemon bridge fixed CIDR
-h, --help help for updatedaemon
--home-dir string update daemon home dir
--image-proxy string update daemon image proxy
--ipforward udpate daemon with ipforward (default true)
--iptables update daemon with iptables (default true)
--label strings update daemon labels
--manager-white-list string update daemon manager white list
--offline just update daemon config file
--snapshotter string update daemon snapshotter
--userland-proxy update daemon with userland proxy
```

Expand Down