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 #1022

Merged
merged 1 commit into from
Mar 31, 2018
+8 −3
Merged

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

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 @@ -14,6 +14,7 @@ chenzhimin <1141685075@qq.com>
Cindy <176425810@qq.com>
CodeJuan <CodeJuan@users.noreply.github.com>
codejuan <xh@decbug.com>
Dewey-Ding <deweyding@gmail.com>
Frank Yang <yyb196@gmail.com>
frankyang <yyb196@gmail.com>
GodweiFighting <1250394994@qq.com>
Expand Down
4 changes: 4 additions & 0 deletions docs/api/HTTP_API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1957,12 +1957,16 @@ A mount point inside a container

|Name|Schema|
|---|---|
|**CopyData** <br>*optional*|boolean|
|**Destination** <br>*optional*|string|
|**Driver** <br>*optional*|string|
|**ID** <br>*optional*|string|
|**Mode** <br>*optional*|string|
|**Name** <br>*optional*|string|
|**Named** <br>*optional*|boolean|
|**Propagation** <br>*optional*|string|
|**RW** <br>*optional*|boolean|
|**Replace** <br>*optional*|string|
|**Source** <br>*optional*|string|
|**Type** <br>*optional*|string|

Expand Down
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 @@ -68,7 +68,7 @@ container ID: e1d541722d68dc5d133cca9e7bd8fd9338603e1763096c8e853522b60d11f7b9,
-t, --tty Allocate a pseudo-TTY
-u, --user string UID
--uts string UTS namespace to use
-v, --volume strings Bind mount volumes to container
-v, --volume strings 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"
-w, --workdir string Set the working directory in a container
```

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 @@ -83,7 +83,7 @@ crw-rw-rw- 1 root root 1, 3 Jan 8 09:40 /dev/testnull
-t, --tty Allocate a pseudo-TTY
-u, --user string UID
--uts string UTS namespace to use
-v, --volume strings Bind mount volumes to container
-v, --volume strings 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"
-w, --workdir string Set the working directory in a container
```

Expand Down
2 changes: 1 addition & 1 deletion docs/commandline/pouch_upgrade.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ test1
-t, --tty Allocate a pseudo-TTY
-u, --user string UID
--uts string UTS namespace to use
-v, --volume strings Bind mount volumes to container
-v, --volume strings 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"
-w, --workdir string Set the working directory in a container
```

Expand Down