summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorjasplin <qt-info@nokia.com>2009-09-09 13:17:50 +0200
committerjasplin <qt-info@nokia.com>2009-09-09 13:17:50 +0200
commitc314d4da3317be222ce6d95c6d36bedf3df890b1 (patch)
treee28cbfe8bd3dea22cbef778d60aa430891ac3c09 /doc
parentd47c2e1b220d7903a348f08f602239f1df865460 (diff)
Implemented 'Trend' column.
Diffstat (limited to 'doc')
-rw-r--r--doc/bmc.html36
1 files changed, 27 insertions, 9 deletions
diff --git a/doc/bmc.html b/doc/bmc.html
index 312f881..7c6d7f5 100644
--- a/doc/bmc.html
+++ b/doc/bmc.html
@@ -389,7 +389,7 @@ Content-type: text/json
</pre>
</td>
<td class="commandDescr">
-Lists results within a particular historical range for a particular context.
+Lists the latest results within a particular historical range for a particular context.
<br /><br />
The results are filtered in three ways:
@@ -398,7 +398,7 @@ The results are filtered in three ways:
<li>
Only results within a certain snapshot range are considered. This range is
defined by the <span class="command">-timestamp</span>/<span
-class="command">-sha1</span> options. If a <span
+class="command">-sha1</span> options. If the <span
class="command">-timestamp</span> option is used, the values
<i>first</i> and <i>last</i> specify the first and last
available snapshot respectively. Otherwise, the first timestamp refers to the earliest
@@ -412,9 +412,10 @@ exact value must exist.
<li>
Chronologically consecutive results that differ by less than a certain
-<i>tolerance</i> are collapsed into a single result. More precisely, the
-representative result is the latest result of each such "equivalence span",
-and the differences are measured in percentages of the representative result.
+<i>tolerance</i> are collapsed into a single result. Results are processed
+in reverse chronological order, and the the representative result of each
+"equivalence span" is always the latest result. Differences are are measured
+in percentages of the representative result.
<br /><br />
Observe that a tolerance value of zero effectively disables this filter (since
no (absolute) differences can be less than zero).
@@ -422,12 +423,12 @@ no (absolute) differences can be less than zero).
</li>
<li>
-The number of equivalence spans is limited by a certain <i>size
-</i>.
+The number of equivalence spans is limited by a certain <i>size</i>. Older
+results are not included.
<br /><br />
Use a negative size value to disable this filter and get all available spans.
<br /><br />
-Observe that a size of one simply retrieves the last result within the
+Observe that a size of one simply retrieves the latest result within the
snapshot range.
</li>
@@ -446,8 +447,25 @@ snapshot range.
&lt;iterations 2&gt;
...
</pre>
+<td>
+<pre>
+Content-type: text/json
+
+{
+ "items": [
+ ["&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>
-<td><span style="color:red">2 B DONE</span></td>
</tr>
<!-- ---------------------------------------------------------------------------------- -->