summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorjasplin <qt-info@nokia.com>2009-12-14 13:54:38 +0100
committerjasplin <qt-info@nokia.com>2009-12-14 13:54:38 +0100
commite2aa74dab12688af125a380b6576df6fa5f61bf7 (patch)
tree731342663f4bc9f655f1aa444d1e043ef118e217 /doc
parent8d0ad9b98fbbb3e09721ce4b107623ea5cbe81e9 (diff)
Obsoleted 'iterations' and added DB indexes.
The most important change of this commit is that the 'iterations' component of the result value is gone. Now the result value represented by just the final real-valued result, rather than two integer components: (accumulated) result and number of iterations. NOTE: The old file format is still accepted, and when an iterations component is present, the result component will be divided by this one. The other significant change of this commit is that indexes are added to the database scheme to speed up queries. This only affects the 'initdb' command-line option, though.
Diffstat (limited to 'doc')
-rw-r--r--doc/bmclient.html25
-rw-r--r--doc/bmproto.html28
-rw-r--r--doc/er-diagram.diabin3764 -> 3649 bytes
3 files changed, 19 insertions, 34 deletions
diff --git a/doc/bmclient.html b/doc/bmclient.html
index e4b39bb..b99b88e 100644
--- a/doc/bmclient.html
+++ b/doc/bmclient.html
@@ -433,10 +433,7 @@ For the sake of the following description, denote the input time series as:
&hellip;,&nbsp;(t<sub><i>n</i></sub>,&nbsp;v<sub><i>n</i></sub>),
<br /><br />
where t<sub><i>i</i></sub> is the timestamp component of snapshot <i>i</i> and
-v<sub><i>i</i></sub> is the accumulated value of the corresponding result
-divided by the number of iterations required to produce it. (<b>Note:</b> The
-accumulated value is a non-negative integer, and is sometimes imprecisely
-referred to as the "value"!)
+v<sub><i>i</i></sub> the corresponding result value.
<br /><br />
<b>Difference</b>
@@ -587,7 +584,6 @@ the <span class="command"><b>get detailspage</b></span> command:
or -1&gt;
&lt;sha1 (ditto)&gt;
&lt;value (ditto)&gt;
-&lt;iterations (ditto)&gt;
&lt;last value \
stability (true, \
false, or -1)&gt;
@@ -599,11 +595,9 @@ the <span class="command"><b>get detailspage</b></span> command:
&lt;timestamp 1&gt;
&lt;sha1 1&gt;
&lt;value 1&gt;
-&lt;iterations 1&gt;
&lt;timestamp 2&gt;
&lt;sha1 2&gt;
&lt;value 2&gt;
-&lt;iterations 2&gt;
...
</pre>
<td>
@@ -617,8 +611,7 @@ Content-type: text/json
"stable": &lt;true or false&gt;,
"result": ["&lt;timestamp&gt;",
"&lt;sha1&gt;",
- "&lt;value&gt;",
- "&lt;iterations&gt;"]
+ "&lt;value&gt;"]
},
// Property omitted if no
// current change exists
@@ -637,12 +630,10 @@ Content-type: text/json
"results": [
["&lt;timestamp 1&gt;",
"&lt;sha1 1&gt;",
- "&lt;value 1&gt;",
- "&lt;iterations 1&gt;"],
+ "&lt;value 1&gt;"],
["&lt;timestamp 2&gt;",
"&lt;sha1 2&gt;",
- "&lt;value 2&gt;",
- "&lt;iterations 2&gt;"],
+ "&lt;value 2&gt;"],
...
]
}
@@ -818,7 +809,6 @@ Content-type: text/json
&lt;timestamp&gt;,
"&lt;sha1&gt;",
&lt;value&gt;,
- &lt;iterations&gt;,
&lt;stable&gt;
],
// Property omitted if no
@@ -828,7 +818,6 @@ Content-type: text/json
&lt;timestamp&gt;,
"&lt;sha1&gt;",
&lt;value&gt;,
- &lt;iterations&gt;,
&lt;stable&gt;
],
// Property omitted if no
@@ -906,7 +895,6 @@ Content-type: text/json
&lt;timestamp&gt;,
"&lt;sha1&gt;",
&lt;value&gt;,
- &lt;iterations&gt;,
&lt;stable&gt;
],
@@ -914,7 +902,6 @@ Content-type: text/json
&lt;timestamp&gt;,
"&lt;sha1&gt;",
&lt;value&gt;,
- &lt;iterations&gt;,
&lt;stable&gt;
]
},
@@ -1088,7 +1075,6 @@ test function, data tag, and metric from the given file.
<td>
<pre>
&lt;value&gt;
-&lt;iterations&gt;
</pre>
</td>
<td><i>not supported</i></td>
@@ -1171,8 +1157,7 @@ Content-type: text/json
{
"dataTag": "&lt;data tag&gt;",
"metric": "&lt;metric&gt;",
- "value": "&lt;value&gt;",
- "iterations": "&lt;iterations&gt;"
+ "value": "&lt;value&gt;"
},
...
]
diff --git a/doc/bmproto.html b/doc/bmproto.html
index b2b4db6..657f6dc 100644
--- a/doc/bmproto.html
+++ b/doc/bmproto.html
@@ -62,7 +62,7 @@ Adds new results to the database.
testCase="..." /&gt;
&lt;testFunction name="..."&gt;
&lt;dataTag name="..." metric="..."
- value"..." iterations="..." /&gt;
+ value"..." /&gt;
...
&lt;/testFunction&gt;
...
@@ -312,13 +312,13 @@ the specified value.
&lt;reply type="GetHistory"&gt;
&lt;currChange index="..." stable="..."
timestamp="..." sha1="..."
- value="..." iterations="..." /&gt;
+ value="..." /&gt;
&lt;lastValue stable="..." /&gt;
&lt;regression a="..." b="..." /&gt;
&lt;result timestamp="..." sha1="..."
- value="..." iterations="..." /&gt;
+ value="..." /&gt;
&lt;result timestamp="..." sha1="..."
- value="..." iterations="..." /&gt;
+ value="..." /&gt;
...
&lt;/reply&gt;
</pre>
@@ -358,23 +358,23 @@ Lists statistics and history for a specific benchmark in two branches.
&lt;reply type="GetHistory2"&gt;
&lt;currChange1 index="..." stable="..."
timestamp="..." sha1="..."
- value="..." iterations="..." /&gt;
+ value="..." /&gt;
&lt;lastValue1 stable="..." /&gt;
&lt;regression1 a="..." b="..." /&gt;
&lt;result1 timestamp="..." sha1="..."
- value="..." iterations="..." /&gt;
+ value="..." /&gt;
&lt;result1 timestamp="..." sha1="..."
- value="..." iterations="..." /&gt;
+ value="..." /&gt;
...
&lt;currChange2 index="..." stable="..."
timestamp="..." sha1="..."
- value="..." iterations="..." /&gt;
+ value="..." /&gt;
&lt;lastValue2 stable="..." /&gt;
&lt;regression2 a="..." b="..." /&gt;
&lt;result2 timestamp="..." sha1="..."
- value="..." iterations="..." /&gt;
+ value="..." /&gt;
&lt;result2 timestamp="..." sha1="..."
- value="..." iterations="..." /&gt;
+ value="..." /&gt;
...
&lt;/reply&gt;
</pre>
@@ -421,10 +421,10 @@ exists (or can be computed in the case of the regression).
testFunction="..." dataTag="..."&gt;
&lt;lastValue timestamp="..."
sha1="..." value="..."
- iterations="..." stable="..." /&gt;
+ stable="..." /&gt;
&lt;currChange timestamp="..."
sha1="..." value="..."
- iterations="..." stable="..." /&gt;
+ stable="..." /&gt;
&lt;regression a="..." b="..." /&gt;
&lt;/benchmark&gt;
...
@@ -465,10 +465,10 @@ two branches.
testFunction="..." dataTag="..."&gt;
&lt;lastValue1 timestamp="..."
sha1="..." value="..."
- iterations="..." stable="..." /&gt;
+ stable="..." /&gt;
&lt;lastValue2 timestamp="..."
sha1="..." value="..."
- iterations="..." stable="..." /&gt;
+ stable="..." /&gt;
&lt;/benchmark&gt;
...
&lt;/reply&gt;
diff --git a/doc/er-diagram.dia b/doc/er-diagram.dia
index cbff809..08e713f 100644
--- a/doc/er-diagram.dia
+++ b/doc/er-diagram.dia
Binary files differ