Skip to content

Commit

Permalink
Merge pull request #2259 from pouchrobot/auto-doc-2018-09-20
Browse files Browse the repository at this point in the history
docs: auto generate pouch cli/api docs via code
  • Loading branch information
fuweid authored Sep 20, 2018
2 parents 545f303 + 60de84e commit 73ce641
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 6 deletions.
1 change: 1 addition & 0 deletions CONTRIBUTORS
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
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
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

0 comments on commit 73ce641

Please sign in to comment.