diff options
author | jasplin <qt-info@nokia.com> | 2010-01-26 13:20:17 +0100 |
---|---|---|
committer | jasplin <qt-info@nokia.com> | 2010-01-26 13:20:17 +0100 |
commit | 9375dc74f7e1df769e8bb61ca814462af335816e (patch) | |
tree | 99ee907af947f1a94728dd5a9206f722f32cdee3 /doc | |
parent | 79bb2155e004373e9caef22ec06418317df4e2f2 (diff) |
Obsoleted SHA-1 option in time ranges.
Time ranges are now specified using either
Unix timestamps or 'first' or 'last'. The
option of specifying a SHA-1 value was
considered not to be particularly useful
in practice. This option has therefore
been obsoleted to simplify the code.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/bmclient.html | 46 | ||||
-rw-r--r-- | doc/bmproto.html | 27 |
2 files changed, 22 insertions, 51 deletions
diff --git a/doc/bmclient.html b/doc/bmclient.html index ac491bb..f6f2406 100644 --- a/doc/bmclient.html +++ b/doc/bmclient.html @@ -389,12 +389,7 @@ Content-type: text/json <test function> <data tag> \ <metric> <platform> <host> \ <git repo> <git branch> \ - {-timestamp \ - <first Unix timestamp> | \ - -sha1 <first sha1>} \ - {-timestamp \ - <last Unix timestamp> | \ - -sha1 <last sha1>} \ + -timerange <from> <to> \ <diff tolerance> \ <stab tolerance> \ <max size> \ @@ -414,16 +409,12 @@ the <i>input</i> time series. The command also lists the most recent fraction <br /><br /> The range of the input time series is defined by the <span -class="command">-timestamp</span>/<span class="command">-sha1</span> options. -If the <span class="command">-timestamp</span> option is used, the values -<b><code>first</code></b> and <b><code>last</code></b> 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 timestamp refers to the latest snapshot that is not later than the -specified value. - -<b>Note:</b> Using the <span class="command">-sha1</span> option requires a -snapshot with this exact value to exist for the command to succeed. +class="command">-timerange</span> option. Each of the two arguments to this +option may be either 1) <b><code>first</code></b> or <b><code>last</code></b> to +specify the first and last available snapshot respectively, or 2) a Unix +timestamp value (an integer) that refers to the earliest snapshot that is not +earlier than, or the latest snapshot that is not later than the specified +value respectively. <br /><br /> For the sake of the following description, denote the input time series as @@ -659,12 +650,7 @@ Content-type: text/html <metric> <platform> <host> \ <git repo 1> <git branch 1> \ <git repo 2> <git branch 2> \ - {-timestamp \ - <first Unix timestamp> | \ - -sha1 <first sha1>} \ - {-timestamp \ - <last Unix timestamp> | \ - -sha1 <last sha1>} \ + -timerange <from> <to> \ <diff tolerance> \ <stab tolerance> \ <max size> \ @@ -708,12 +694,7 @@ Content-type: text/html ./bmclient <b>get rankedbenchmarks</b> \ <metric> <platform> <host> \ <git repo> <git branch> \ - {-timestamp \ - <first Unix timestamp> | \ - -sha1 <first sha1>} \ - {-timestamp \ - <last Unix timestamp> | \ - -sha1 <last sha1>} \ + -timerange <from> <to> \ <diff tolerance> \ <stab tolerance> \ <ranking> <scope> \ @@ -920,12 +901,7 @@ Content-type: text/json ./bmclient <b>get stats</b> \ <metric> <platform> <host> \ <git repo> <git branch> \ - {-timestamp \ - <first Unix timestamp> | \ - -sha1 <first sha1>} \ - {-timestamp \ - <last Unix timestamp> | \ - -sha1 <last sha1>} \ + -timerange <from> <to> \ <diff tolerance> \ <stab tolerance> </pre> @@ -969,7 +945,7 @@ Content-type: text/json <tr> <td> <pre class="command"> -./bmclient <b>get context</b> +./bmclient <b>get contexts</b> </pre> </td> <td class="commandDescr"> diff --git a/doc/bmproto.html b/doc/bmproto.html index 70178b5..2cf9d80 100644 --- a/doc/bmproto.html +++ b/doc/bmproto.html @@ -267,13 +267,12 @@ Behaves similarly to GetBenchmarks (see this). Lists statistics and history for a specific benchmark. <br /><br /> -<b>Note:</b> For each snapshot (defining the beginning and end of the range -respectively) only one of <i>timestamp</i> or <i>sha1</i> is required. If -<i>timestamp</i> 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 timestamp refers to the latest snapshot that is not later than -the specified value. +<b>Note:</b> For the timestamp1 and timestamp2 attributes (defining the +beginning and end of the snapshot range respectively), 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 timestamp +refers to the latest snapshot that is not later than the specified value. <br /><br /> <b>Notes:</b> @@ -299,8 +298,7 @@ the specified value. dataTag="..." metric="..." platform="..." host="..." gitRepo="..." gitBranch="..." - timestamp1="..." sha11="..." - timestamp2="..." sha12="..." + timestamp1="..." timestamp2="..." diffTolerance="..." stabTolerance="..." maxSize="..." /> </request> @@ -345,8 +343,7 @@ Lists statistics and history for a specific benchmark in two branches. platform="..." host="..." gitRepo1="..." gitBranch1="..." gitRepo2="..." gitBranch2="..." - timestamp1="..." sha11="..." - timestamp2="..." sha12="..." + timestamp1="..." timestamp2="..." diffTolerance="..." stabTolerance="..." maxSize="..." /> </request> @@ -389,7 +386,7 @@ Lists statistics and history for a specific benchmark in two branches. Lists the benchmarks with the most important <i>last difference</i> values. <br /><br /> -The snapshot range (timestamp{1..2} / sha1{1..2}) is defined as for the <span +The snapshot range (timestamp1/2) is defined as for the <span class="requestName">GetHistory</span> request (see this). <br /><br /> @@ -405,8 +402,7 @@ exists (or can be computed in the case of the regression). <context metric="..." platform="..." host="..." gitRepo="..." gitBranch="..." - timestamp1="..." sha11="..." - timestamp2="..." sha12="..." + timestamp1="..." timestamp2="..." diffTolerance="..." stabTolerance="..." ranking="..." scope="..." maxSize="..." @@ -495,8 +491,7 @@ Computes basic statistics for the benchmarks within a certain context. <context metric="..." platform="..." host="..." gitRepo="..." gitBranch="..." - timestamp1="..." sha11="..." - timestamp2="..." sha12="..." + timestamp1="..." timestamp2="..." diffTolerance="..." stabTolerance="..." /> </request> </pre> |