diff options
author | Clark Williams <williams@redhat.com> | 2009-08-27 16:56:31 -0500 |
---|---|---|
committer | Clark Williams <williams@redhat.com> | 2009-08-27 16:56:31 -0500 |
commit | be13601aaa86e63e8d9af241308b3fd63f63b181 (patch) | |
tree | 4f5681170e31064b0c2d9cb82bee5fd2446ad4e8 | |
parent | d5b7dbcf0ca1542a8033d3441af2e01967c71b4a (diff) | |
download | rteval-be13601aaa86e63e8d9af241308b3fd63f63b181.tar.gz rteval-be13601aaa86e63e8d9af241308b3fd63f63b181.tar.xz rteval-be13601aaa86e63e8d9af241308b3fd63f63b181.zip |
Added a TODO file for keeping track of things we need to do for rteval
and added first cut at a man page.
-rw-r--r-- | TODO | 15 | ||||
-rw-r--r-- | doc/rteval.8 | 112 |
2 files changed, 127 insertions, 0 deletions
@@ -0,0 +1,15 @@ +1. Write a man page. + +2. Figure out some sort of config file to adjust load and measurement parameters, then +add an option to tell rteval to use a particular config file. + +3. Figure out how to add more loads. Seems that we could do it two ways: + + - create a wrapper python module just like is done for kcompile and hackbench + then add the new module to a config file so rteval loads it on startup + + - figure out some generic load wrapper so that arbitrary commands may be + used as loads. + + Heck, maybe we could do both. + diff --git a/doc/rteval.8 b/doc/rteval.8 new file mode 100644 index 0000000..7eb46ec --- /dev/null +++ b/doc/rteval.8 @@ -0,0 +1,112 @@ +.\" Hey, EMACS: -*- nroff -*- +.TH RTEVAL 8 "august 27, 2009" +.\" 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 +rteval \- evaluate latency performance of a realtime Linux system +.SH SYNOPSIS +.B rteval +.RI "[ \-hvsLSDOZ ] [\-d " duration " ] [\-w " workdir " ] [\-l " loaddir " ] \ +[\-X " host " ]" + +.\" .SH DESCRIPTION +.\" This manual page documents briefly the +.\" .B rteval command. +.\" .PP +.\" \fI<whatever>\fP escape sequences to invode bold face and italics, respectively. +.\" \fBcyclictest\fP is a program that... + +The rteval program is used to evaluate the realtime performance of a +realtime Linux kernel on a particular hardware system. There is +nothing that actually requires a realtime Linux kernel, but the +latency measurements will usually be pretty bad on a stock Linux +kernel. + + +.SH OPTIONS +These programs follow the usual GNU command line syntax, with long +options starting with two dashes ('\-\-'). +.br +A summary of options is included below. +.\" For a complete description, see the Info files. +.TP +.B \-h, \-\-help +print a help message +.TP +.B -d, \-\-duration=DURATION +Specify the length of the measurement run. DURATION is an integer with +an optional suffix indicating the units: + +.br + s - seconds +.br + m - minutes +.br + h - hours +.br + d - days +.br +for example to execute a ten minute run of rteval: +.br + $ rteval \-\-duration=10m +.TP +.B \-v, \-\-verbose +Increase the verbosity of output during the test run +.TP +.B \-w, \-\-workdir=WORKDIR +Tell rteval to change directory to WORKDIR before creating any +subdirectories for report files. The default WORKDIR is the directory +in which rteval was started. +.TP +.B \-l, \-\-loaddir=LOADDIR +Tell rteval where to find the source for the loads +.TP +.B \-s, \-\-sysreport +Have rteval run the sysreport utility after a run to gather +information on the running system. +.TP +.B \-D, \-\-debug +Turn on debugging prints during run +.TP +.B \-X, \-\-xmprpc-submit=HOST +Have rteval send report data to HOST following the run, using XML-RPC +.TP +.B \-Z, \-\-summarize +Have rteval summarize an existing report. This will not cause loads or +meausurement utilities to be run. +.\" .SH SEE ALSO +.\" .BR bar (1), +.\" .BR baz (1). +.\" .br + +.SH FILES +.BR rteval-YYYYMMDD-S +This is a directory created by rteval to hold the summary.xml file as +well as other files collected on the system. It is the current Year, +Month, and Day, followed by a sequence number for multiple runs on the +same day. + +.BR summary.xml +This is an XML file that contains information about a test run and the +host system upon which rteval was run. +.BR dmesg +This is the output of the dmesg(1) program immediately following +system boot. It is copied from /var/log/dmesg. + +.SH SEE ALSO +.BR cyclictest(8). +.br +.SH AUTHOR +rteval was written by Clark Williams <williams@redhat.com> +.PP +XML-RPC and database code by David Sommerseth <davids@redhat.com> |