summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMac Mollison <mollison@cs.unc.edu>2010-04-03 23:50:55 -0400
committerMac Mollison <mollison@cs.unc.edu>2010-04-03 23:50:55 -0400
commit476ed70854583179729b2ec47439a4bd2f9a2184 (patch)
tree3bbec7d8e5f2816e4b0b5cb5d9b5af0d24733acf
parentabcd73adcf326b59d17c43ba902e3800ebcac681 (diff)
Further doc updates
- Public release info - Minor clarifications
-rw-r--r--doc/index.txt26
1 files 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.
10</span> 10</span>
11 11
12## About This Document ## 12## About This Document ##
13This document contains instructions for people who want to use and/or contribute to Unit-Trace. 13This document is both the offical Unit-Trace website and the complete Unit-Trace documentation.
14It is the complete documentation for Unit-Trace.
15 14
16## Obtaining Unit-Trace ## 15## Obtaining Unit-Trace ##
17Members of UNC's Real-Time Group can obtain Unit-Trace using:<br> 16The latest public release of Unit-Trace (currently 2010.1) is available at:<br>
17[http://cs.unc.edu/~mollison/unit-trace/unit-trace.tar.gz][release]
18
19Members of UNC's Real-Time Group should obtain Unit-Trace using:<br>
18<codeblock>git clone ssh://cvs.cs.unc.edu/cvs/proj/litmus/repo/unit-trace.git</codeblock> 20<codeblock>git clone ssh://cvs.cs.unc.edu/cvs/proj/litmus/repo/unit-trace.git</codeblock>
19 21
20## Installing Unit-Trace ## 22## Installing Unit-Trace ##
21Dependencies: Python 2.6; for the visualizer, pygtk and pycairo. 23Dependencies: Python 2.6; for the visualizer, pygtk and pycairo.
22 24
23Unit_Trace consists of a Python module called `unit_trace` (encapsulated in the `unit_trace` directory) and a font-end script called `unit-trace`. 25Unit-Trace consists of a Python module called `unit_trace` (encapsulated in the `unit_trace` directory) and a font-end script called `unit-trace`.
24 26
25You can use `install.py` to install unit-trace, or install manually by copying the `unit-trace` script and the `unit_trace` directory 27You can use `install.py` to install Unit-Trace, or install manually by copying the `unit-trace` script and the `unit_trace` directory
26to `~/bin`. 28to `~/bin`.
27 29
28Make sure `~/bin` is on your `PATH`. 30Make 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
53Use the following command:<br> 55Use the following command:<br>
54<codeblock>unit-trace *.bin -e &lt;the first event ID&gt; -l &lt;the second event ID&gt; -v</codeblock>. 56<codeblock>unit-trace *.bin -e &lt;the first event ID&gt; -l &lt;the second event ID&gt; -v</codeblock>.
55 57
56Note 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. 58Note that if the visualizer stops at the second specified event (which it will), any tasks running at that point will appear to
57Since you're probably interested in what happened after the priority inversion ended (for at least a little while), you should probably specify 59keep running forever. If you specify a slightly later second event ID (e.g. 100 greater than the actual one), this won't affect
58a slightly later second event ID (e.g. 100 greater than the actual ending event ID). 60the jobs you're actually interested in.
59 61
60Now, suppose you want to see specific textual output for all events. (You could also specify a range if you wanted to.)<br> 62Now, suppose you want to see specific textual output for all events. (You could also specify a range if you wanted to.)<br>
61<codeblock>unit-trace *.bin -o > output</codeblock> 63<codeblock>unit-trace *.bin -o > output</codeblock>
@@ -79,7 +81,10 @@ Some submodules have further documentation, appearing later in this document.
79### Input Submodules ### 81### Input Submodules ###
80<table border=1> 82<table border=1>
81<tr><td>Name</td><td>Flag</td><td>Parameters</td><td>Description</td></tr> 83<tr><td>Name</td><td>Flag</td><td>Parameters</td><td>Description</td></tr>
82<tr><td>trace_parser</td><td>(on by default)</td><td>(None)</td><td>Parses LITMUS<sup>RT</sup> traces</td></tr> 84<tr>
85<td>trace_parser</td>
86<td>always on, unless/until modules for other trace formats are contributed</td>
87<td>(None)</td><td>Parses LITMUS<sup>RT</sup> traces</td></tr>
83</table> 88</table>
84### Filter Submodules ### 89### Filter Submodules ###
85<table border=1> 90<table border=1>
@@ -130,7 +135,7 @@ This behavior may have to be modified in the future if non-nanosecond trace file
130 135
131Here, documentation of known bugs is provided. 136Here, documentation of known bugs is provided.
132 137
133(No known bugs right now --- but we are CERTAIN that there are some hiding...) 138(No known bugs right now --- but there may be some hiding...)
134 139
135 140
136## Development ## 141## Development ##
@@ -184,3 +189,4 @@ We hope to have additional contributors in the future.
184[markdown]: http://daringfireball.net/projects/markdown/ 189[markdown]: http://daringfireball.net/projects/markdown/
185[mac]: mailto:mollison@cs.unc.edu 190[mac]: mailto:mollison@cs.unc.edu
186[license]: LICENSE 191[license]: LICENSE
192[release]: http://cs.unc.edu/~mollison/unit-trace/unit-trace.tar.gz