From deabef94f25b0dcf46e30e64f99f4b82b536ed94 Mon Sep 17 00:00:00 2001 From: pouchrobot Date: Wed, 16 May 2018 01:28:46 +0000 Subject: [PATCH] docs: auto generate pouch cli docs via code Signed-off-by: pouchrobot --- CONTRIBUTORS | 1 + docs/commandline/pouch_exec.md | 10 ++++++++++ docs/commandline/pouch_top.md | 6 +++--- 3 files changed, 14 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTORS b/CONTRIBUTORS index 5ca1ae005..385c7dcba 100644 --- a/CONTRIBUTORS +++ b/CONTRIBUTORS @@ -43,6 +43,7 @@ Runrioter Wung Sam Xie skoo skoo87 +soarpenguin Starnop Tao Qingyun <845767657@qq.com> Tiramisu 1993 diff --git a/docs/commandline/pouch_exec.md b/docs/commandline/pouch_exec.md index 626cce1dd..b92aeeb6d 100644 --- a/docs/commandline/pouch_exec.md +++ b/docs/commandline/pouch_exec.md @@ -10,6 +10,16 @@ Exec a process in a running container pouch exec [OPTIONS] CONTAINER COMMAND [ARG...] ``` +### Examples + +``` +$ pouch exec -it 25bf50 ps +PID USER TIME COMMAND + 1 root 0:00 /bin/sh + 38 root 0:00 ps + +``` + ### Options ``` diff --git a/docs/commandline/pouch_top.md b/docs/commandline/pouch_top.md index ca7336728..9b8fb720f 100644 --- a/docs/commandline/pouch_top.md +++ b/docs/commandline/pouch_top.md @@ -14,9 +14,9 @@ pouch top CONTAINER [ps OPTIONS] ``` $ pouch top 44f675 - UID PID PPID C STIME TTY TIME CMD - root 28725 28714 0 3月14 ? 00:00:00 sh - +UID PID PPID C STIME TTY TIME CMD +root 28725 28714 0 3月14 ? 00:00:00 sh + ``` ### Options