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.

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

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

Merged
merged 2 commits into from
Sep 20, 2018
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
41976ba
docs: auto generate pouch cli docs via code
pouchrobot Sep 19, 2018
60de84e
docs: auto generate pouch cli docs via code
pouchrobot Sep 20, 2018
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 @@ -46,6 +46,7 @@ Leno Hou <lenohou@gmail.com>
letty <learn5411@gmail.com>
letty <letty.ll@alibaba-inc.com>
letty.ll <letty.ll@alibaba-inc.com>
Lifubang <lifubang@acmcoder.com>
luman.qy <luman.qy@cainiao.com>
Mark Liu <manlge168@gmail.com>
MarkLux <marlx6590@163.com>
Expand Down
3 changes: 2 additions & 1 deletion docs/api/HTTP_API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -749,7 +749,7 @@ POST /containers/{id}/stop
<a name="containertop"></a>
### Display the running processes of a container
```
POST /containers/{id}/top
GET /containers/{id}/top
```


Expand Down Expand Up @@ -2449,6 +2449,7 @@ is a small subset of the Config struct that holds the configuration.
|**Cmd** <br>*optional*|Execution commands and args|< string > array|
|**Detach** <br>*optional*|Execute in detach mode|boolean|
|**DetachKeys** <br>*optional*|Escape keys for detach|string|
|**Env** <br>*optional*|envs for exec command in container|< string > array|
|**Privileged** <br>*optional*|Is the container in privileged mode|boolean|
|**Tty** <br>*optional*|Attach standard streams to a tty|boolean|
|**User** <br>*optional*|User that will run the command|string|
Expand Down
11 changes: 6 additions & 5 deletions docs/commandline/pouch_exec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,12 @@ PID USER TIME COMMAND
### Options

```
-d, --detach Run the process in the background
-h, --help help for exec
-i, --interactive Open container's STDIN
-t, --tty Allocate a tty device
-u, --user string Username or UID (format: <name|uid>[:<group|gid>])
-d, --detach Run the process in the background
-e, --env stringArray Set environment variables
-h, --help help for exec
-i, --interactive Open container's STDIN
-t, --tty Allocate a tty device
-u, --user string Username or UID (format: <name|uid>[:<group|gid>])
```

### Options inherited from parent commands
Expand Down