From 476ed70854583179729b2ec47439a4bd2f9a2184 Mon Sep 17 00:00:00 2001 From: Mac Mollison Date: Sat, 3 Apr 2010 23:50:55 -0400 Subject: Further doc updates - Public release info - Minor clarifications --- doc/index.txt | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/doc/index.txt b/doc/index.txt index dbb37b7..9360e40 100644 --- a/doc/index.txt +++ b/doc/index.txt @@ -10,19 +10,21 @@ information about scheduler behavior. ## About This Document ## -This document contains instructions for people who want to use and/or contribute to Unit-Trace. -It is the complete documentation for Unit-Trace. +This document is both the offical Unit-Trace website and the complete Unit-Trace documentation. ## Obtaining Unit-Trace ## -Members of UNC's Real-Time Group can obtain Unit-Trace using:
+The latest public release of Unit-Trace (currently 2010.1) is available at:
+[http://cs.unc.edu/~mollison/unit-trace/unit-trace.tar.gz][release] + +Members of UNC's Real-Time Group should obtain Unit-Trace using:
git clone ssh://cvs.cs.unc.edu/cvs/proj/litmus/repo/unit-trace.git ## Installing Unit-Trace ## Dependencies: Python 2.6; for the visualizer, pygtk and pycairo. -Unit_Trace consists of a Python module called `unit_trace` (encapsulated in the `unit_trace` directory) and a font-end script called `unit-trace`. +Unit-Trace consists of a Python module called `unit_trace` (encapsulated in the `unit_trace` directory) and a font-end script called `unit-trace`. -You can use `install.py` to install unit-trace, or install manually by copying the `unit-trace` script and the `unit_trace` directory +You can use `install.py` to install Unit-Trace, or install manually by copying the `unit-trace` script and the `unit_trace` directory to `~/bin`. Make sure `~/bin` is on your `PATH`. @@ -53,9 +55,9 @@ Given in the output for each one are the event IDs at the beginning and end of t Use the following command:
unit-trace *.bin -e <the first event ID> -l <the second event ID> -v. -Note that if the visualizer stops at the second specified event (which it will), it will not be able to render anything that happens after that. -Since you're probably interested in what happened after the priority inversion ended (for at least a little while), you should probably specify -a slightly later second event ID (e.g. 100 greater than the actual ending event ID). +Note that if the visualizer stops at the second specified event (which it will), any tasks running at that point will appear to +keep running forever. If you specify a slightly later second event ID (e.g. 100 greater than the actual one), this won't affect +the jobs you're actually interested in. Now, suppose you want to see specific textual output for all events. (You could also specify a range if you wanted to.)
unit-trace *.bin -o > output @@ -79,7 +81,10 @@ Some submodules have further documentation, appearing later in this document. ### Input Submodules ### - + + + +
NameFlagParametersDescription
trace_parser(on by default)(None)Parses LITMUSRT traces
trace_parseralways on, unless/until modules for other trace formats are contributed(None)Parses LITMUSRT traces
### Filter Submodules ### @@ -130,7 +135,7 @@ This behavior may have to be modified in the future if non-nanosecond trace file Here, documentation of known bugs is provided. -(No known bugs right now --- but we are CERTAIN that there are some hiding...) +(No known bugs right now --- but there may be some hiding...) ## Development ## @@ -184,3 +189,4 @@ We hope to have additional contributors in the future. [markdown]: http://daringfireball.net/projects/markdown/ [mac]: mailto:mollison@cs.unc.edu [license]: LICENSE +[release]: http://cs.unc.edu/~mollison/unit-trace/unit-trace.tar.gz -- cgit v1.2.2