102 lines
3.0 KiB
Diff
102 lines
3.0 KiB
Diff
From 803c33cfe83a8e215bdb4f393f90d1e175f78318 Mon Sep 17 00:00:00 2001
|
|
From: John Kacur <jkacur@redhat.com>
|
|
Date: Fri, 2 Nov 2018 16:16:45 +0100
|
|
Subject: [PATCH] rt-tests: deadline_test: Add a manpage
|
|
|
|
Add an initial manpage for deadline_test.
|
|
Modify the Makefile to install it too.
|
|
|
|
Signed-off-by: John Kacur <jkacur@redhat.com>
|
|
---
|
|
Makefile | 1 +
|
|
src/sched_deadline/deadline_test.8 | 65 ++++++++++++++++++++++++++++++++++++++
|
|
2 files changed, 66 insertions(+)
|
|
create mode 100644 src/sched_deadline/deadline_test.8
|
|
|
|
diff --git a/Makefile b/Makefile
|
|
index 26dd96f0c5fd..06f399cc629d 100644
|
|
--- a/Makefile
|
|
+++ b/Makefile
|
|
@@ -186,6 +186,7 @@ install: all install_hwlatdetect
|
|
gzip -c src/signaltest/signaltest.8 >"$(DESTDIR)$(mandir)/man8/signaltest.8.gz"
|
|
gzip -c src/pi_tests/pip_stress.8 >"$(DESTDIR)$(mandir)/man8/pip_stress.8.gz"
|
|
gzip -c src/queuelat/queuelat.8 >"$(DESTDIR)$(mandir)/man8/queuelat.8.gz"
|
|
+ gzip -c src/sched_deadline/deadline_test.8 >"$(DESTDIR)$(mandir)/man8/deadline_test.8.gz"
|
|
|
|
.PHONY: install_hwlatdetect
|
|
install_hwlatdetect: hwlatdetect
|
|
diff --git a/src/sched_deadline/deadline_test.8 b/src/sched_deadline/deadline_test.8
|
|
new file mode 100644
|
|
index 000000000000..5dc99c0bfc63
|
|
--- /dev/null
|
|
+++ b/src/sched_deadline/deadline_test.8
|
|
@@ -0,0 +1,65 @@
|
|
+.\" Hey, EMACS: -*- nroff -*-
|
|
+.TH DEADLINE_TEST 8 "November 1, 2018"
|
|
+.\" Please adjust this date whenever revising the manpage.
|
|
+.\"
|
|
+.\" Some roff macros, for reference:
|
|
+.\" .nh disable hyphenation
|
|
+.\" .hy enable hyphenation
|
|
+.\" .ad l left justify
|
|
+.\" .ad b justify to both left and right margins
|
|
+.\" .nf disable filling
|
|
+.\" .fi enable filling
|
|
+.\" .br insert line break
|
|
+.\" .sp <n> insert n+1 empty lines
|
|
+.\" for manpage-specific macros, see man(7)
|
|
+.SH NAME
|
|
+deadline_test \- High resolution test program
|
|
+.SH DESCRIPTION
|
|
+.PP
|
|
+This program is used to test the deadline scheduler (SCHED_DEADLINE tasks)
|
|
+.SH SYNOPSIS
|
|
+.B deadline_test
|
|
+.RI "[ \-hb ] [ \-r prio ] [ \-c cpulist ] [ \-i interval ] [ \-p percent ] [ \-P percent ] [ \-t threads ] [ \-s step[us) ]"
|
|
+
|
|
+.SH OPTIONS
|
|
+.TP
|
|
+.B \-h
|
|
+Show this help menu
|
|
+.br
|
|
+.TP
|
|
+.B \-b
|
|
+Bind on the last cpu. (shortcut for -c <lastcpu>)
|
|
+.br
|
|
+.TP
|
|
+.B \-r prio
|
|
+Add an RT task with given prio to stress system
|
|
+.br
|
|
+.TP
|
|
+.B \-c cpulist
|
|
+Comma/hyphen separated list of CPUs to run deadline tasks on
|
|
+.br
|
|
+.TP
|
|
+.B \-i interval
|
|
+The shortest deadline for the tasks
|
|
+.br
|
|
+.TP
|
|
+.B \-p percent
|
|
+The percent of bandwidth to use (1-90%)
|
|
+.br
|
|
+.TP
|
|
+.B \-P percent
|
|
+The percent of runtime for execution completion
|
|
+ (Default 100%)
|
|
+.br
|
|
+.TP
|
|
+.B \-t threads
|
|
+The number of threads to run as deadline (default 1)
|
|
+.br
|
|
+.TP
|
|
+.B \-s step(us)
|
|
+The amount to increase the deadline for each task (default 500us)
|
|
+.br
|
|
+.SH AUTHOR
|
|
+Deadline test was written by Steven Rostedt <rostedt@goodmis.org>
|
|
+.PP
|
|
+This manual page was written by John Kacur <jkacur@redhat.com>
|
|
--
|
|
2.14.5
|
|
|