Removed 'get trend' command and instead added size & tolerance to the 'get history' command.

Adding size and tolerance to the 'get history' command effectively eliminates the
need for a 'get trend' command (for now).

2 files changed, 40 insertions, 63 deletions

diff --git a/doc/bmc.html b/doc/bmc.html
index 6d9f01d..3fb1cc2 100644
--- a/doc/bmc.html
+++ b/doc/bmc.html
@@ -298,13 +298,22 @@ Behaves similarly to <span class="command">./bmc get benchmarks ...</span> (see
     {-timestamp &lt;first Unix timestamp&gt; | \
      -sha1 &lt;first sha1&gt;} \
     {-timestamp &lt;last Unix timestamp&gt; | \
-     -sha1 &lt;last sha1&gt;}
+     -sha1 &lt;last sha1&gt;} \
+    [&lt;size&gt; [&lt;tolerance&gt;]]
 </pre>
 </td>
 <td class="commandDescr">
-Lists the raw results within a particular historical range for a particular context.
+Lists results within a particular historical range for a particular context.
 <br /><br />
-If a <span class="command">-timestamp</span> option is used, the values
+The results are filtered in three ways:
+
+<ol>
+
+<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">-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
 snapshot that is not earlier than the specified value, while the second
@@ -312,6 +321,32 @@ timestamp refers to the latest snapshot that is not later than the specified val
 <br /><br />
 If the <span class="command">-sha1</span> option is used, a snapshot with this
 exact value must exist.
+<br /><br />
+</li>
+
+<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.
+<br /><br />
+Observe that a tolerance value of zero effectively disables this filter (since
+no (absolute) differences can be less than zero).
+<br /><br />
+</li>
+
+<li>
+The number of equivalence spans is limited by a certain <i>size
+</i>.
+<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
+snapshot range.
+</li>
+
+</ol>
+
 </td>
 <td>
 <pre>
@@ -333,33 +368,6 @@ exact value must exist.
 <tr>
 <td>
 <pre class="command">
-./bmc get trend &lt;test case&gt; \
-    &lt;test function&gt; &lt;data tag&gt; \
-    &lt;metric&gt; &lt;platform&gt; &lt;host&gt; \
-    &lt;git repo&gt; &lt;git branch&gt; \
-    {-timestamp &lt;first Unix timestamp&gt; | \
-     -sha1 &lt;first sha1&gt;} \
-    {-timestamp &lt;last Unix timestamp&gt; | \
-     -sha1 &lt;last sha1&gt;}
-</pre>
-</td>
-<td class="commandDescr">
-Computes a trend estimation of the results within a particular historical
-range for a particular context. This may simplify the task of detecting
-performance regressions.
-<br /><br />
-The <span class="command">-timestamp</span> and <span
-class="command">-sha1</span> options behave as for <span
-class="command">./bmc analyze dump ...</span> (see this).
-</td>
-<td><span style="color:red">2 B DEFINED</span></td>
-<td><span style="color:red">2 B DONE</span></td>
-</tr>
-
-<!-- ---------------------------------------------------------------------------------- -->
-<tr>
-<td>
-<pre class="command">
 ./bmc get value &lt;test case&gt; \
     &lt;test function&gt; &lt;data tag&gt; \
     &lt;metric&gt; &lt;file&gt;
diff --git a/doc/bmcp.html b/doc/bmcp.html
index 63b4146..ce4ee6f 100644
--- a/doc/bmcp.html
+++ b/doc/bmcp.html
@@ -284,7 +284,8 @@ the specified value.
         platform="..." host="..."
         gitRepo="..." gitBranch="..."
         timestamp1="..." sha11="..."
-        timestamp2="..." sha12="..." /&gt;
+        timestamp2="..." sha12="..."
+        size="..." tolerance="..." /&gt;
 &lt;/request&gt;
 </pre>
 </td>
@@ -303,38 +304,6 @@ the specified value.
 
 </tr>
 
-<!-- ---------------------------------------------------------------------------------- -->
-<tr>
-<td class="requestName">GetTrend</td>
-<td class="requestDescr">
-Computes a trend estimation of the results within a particular historical
-range for a particular context. This may simplify the task of detecting
-performance regressions.
-<br /><br />
-See note above regarding semantics of the timestamp and sha1 attributes.
-</td>
-
-<td>
-<pre>
-&lt;request type="GetTrend"&gt;
-    &lt;context testCase="..." testFunction="..."
-        dataTag="..." metric="..."
-        platform="..." host="..."
-        gitRepo="..." gitBranch="..."
-        timestamp1="..." sha11="..."
-        timestamp2="..." sha12="..." /&gt;
-&lt;/request&gt;
-</pre>
-</td>
-
-<td>
-<pre>
-&lt;reply type="GetTrend" /&gt;
-</pre>
-<span style="color:red">2 B DEFINED</span>
-</td>
-
-</tr>
 
 </table>