fix synopsis options in docs

iovisor · Jan 30, 2016 · 62f4c28 · 62f4c28
1 parent af2b46a
commit 62f4c28
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 6 deletions.
diff --git a/man/man8/offcputime.8 b/man/man8/offcputime.8
@@ -2,7 +2,7 @@
 .SH NAME
 offcputime \- Summarize off-CPU time by kernel stack trace. Uses Linux eBPF/bcc.
 .SH SYNOPSIS
-.B offcputime [\-h] [\-u] [\-p PID] [\-i INTERVAL] [\-T] [duration]
+.B offcputime [\-h] [\-u] [\-p PID] [\-v] [\-f] [duration]
 .SH DESCRIPTION
 This program shows kernel stack traces and task names that were blocked and
 "off-CPU", and the total duration they were not running: their "off-CPU time".
@@ -33,11 +33,14 @@ CONFIG_BPF and bcc.
 \-h
 Print usage message.
 .TP
+\-f
+Print output in folded stack format.
+.TP
 \-u
 Only trace user threads (not kernel threads).
 .TP
 \-v
-Show raw addresses.
+Show raw addresses (for non-folded output).
 .TP
 \-p PID
 Trace this process ID only (filtered in-kernel).

diff --git a/man/man8/wakeuptime.8 b/man/man8/wakeuptime.8
@@ -2,7 +2,7 @@
 .SH NAME
 wakeuptime \- Summarize sleep to wakeup time by waker kernel stack. Uses Linux eBPF/bcc.
 .SH SYNOPSIS
-.B wakeuptime [\-h] [\-u] [\-p PID] [\-i INTERVAL] [\-T] [duration]
+.B wakeuptime [\-h] [\-u] [\-p PID] [\-v] [\-f] [duration]
 .SH DESCRIPTION
 This program shows the kernel stack traces for threads that woke up other 
 blocked threads, along with the process names of the waker and target, along
@@ -34,11 +34,14 @@ CONFIG_BPF and bcc.
 \-h
 Print usage message.
 .TP
+\-f
+Print output in folded stack format.
+.TP
 \-u
 Only trace user threads (not kernel threads).
 .TP
 \-v
-Show raw addresses.
+Show raw addresses (for non-folded format).
 .TP
 \-p PID
 Trace this process ID only (filtered in-kernel).

diff --git a/tools/offcputime.py b/tools/offcputime.py
@@ -3,7 +3,7 @@
 # offcputime    Summarize off-CPU time by kernel stack trace
 #               For Linux, uses BCC, eBPF.
 #
-# USAGE: offcputime [-h] [-u] [-p PID] [-i INTERVAL] [-T] [duration]
+# USAGE: offcputime [-h] [-u] [-p PID] [-v] [-f] [duration]
 #
 # The current implementation uses an unrolled loop for x86_64, and was written
 # as a proof of concept. This implementation should be replaced in the future

diff --git a/tools/wakeuptime.py b/tools/wakeuptime.py
@@ -3,7 +3,7 @@
 # wakeuptime    Summarize sleep to wakeup time by waker kernel stack
 #               For Linux, uses BCC, eBPF.
 #
-# USAGE: wakeuptime [-h] [-u] [-p PID] [-i INTERVAL] [-T] [duration]
+# USAGE: wakeuptime [-h] [-u] [-p PID] [-v] [-f] [duration]
 #
 # The current implementation uses an unrolled loop for x86_64, and was written
 # as a proof of concept. This implementation should be replaced in the future