summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorjasplin <qt-info@nokia.com>2009-08-26 13:39:07 +0200
committerjasplin <qt-info@nokia.com>2009-08-26 13:39:07 +0200
commit6a69bd606ffb56fbdc7e1092772fca0d759e4b31 (patch)
treedcdd60acba82d59c7d8868389b2f162f6239372e /doc
parent1fe033cd8437891a169e4e06cc0ca63ebff0a021 (diff)
Change 'add -results' command to auto-insert missing values.
When adding new results to the database, any missing values (such as test case, host etc.) should be automatically inserted. This also eliminates the need for the commands/requests for explicitly adding benchmarks, metrics, platforms, hosts, and branches.
Diffstat (limited to 'doc')
-rw-r--r--doc/bmc.html67
-rw-r--r--doc/bmcp.html116
-rw-r--r--doc/notes.txt70
3 files changed, 10 insertions, 243 deletions
diff --git a/doc/bmc.html b/doc/bmc.html
index 968d669..87e499d 100644
--- a/doc/bmc.html
+++ b/doc/bmc.html
@@ -56,73 +56,6 @@ or via the <code>BMCSERVER</code> environment variable, e.g.:
<tr>
<td>
<pre class="command">
-./bmc add -benchmark &lt;test case&gt; \
- &lt;test function&gt; &lt;data tag&gt;
-</pre>
-</td>
-<td class="commandDescr">
-Adds a new benchmark to the database.
-</td>
-<td><i>none</i></td>
-</tr>
-
-<!-- ---------------------------------------------------------------------------------- -->
-<tr>
-<td>
-<pre class="command">
-./bmc add -metric &lt;metric&gt;
-</pre>
-</td>
-<td class="commandDescr">
-Adds a new metric to the database.
-</td>
-<td><i>none</i></td>
-</tr>
-
-<!-- ---------------------------------------------------------------------------------- -->
-<tr>
-<td>
-<pre class="command">
-./bmc add -platform &lt;platform&gt;
-</pre>
-</td>
-<td class="commandDescr">
-Adds a new platform to the database.
-</td>
-<td><i>none</i></td>
-</tr>
-
-<!-- ---------------------------------------------------------------------------------- -->
-<tr>
-<td>
-<pre class="command">
-./bmc add -host &lt;host&gt;
-</pre>
-</td>
-<td class="commandDescr">
-Adds a new host to the database.
-</td>
-<td><i>none</i></td>
-</tr>
-
-<!-- ---------------------------------------------------------------------------------- -->
-<tr>
-<td>
-<pre class="command">
-./bmc add -branch &lt;git repo&gt; \
- &lt;git branch&gt;
-</pre>
-</td>
-<td class="commandDescr">
-Adds a new branch to the database.
-</td>
-<td><i>none</i></td>
-</tr>
-
-<!-- ---------------------------------------------------------------------------------- -->
-<tr>
-<td>
-<pre class="command">
./bmc add -results &lt;file&gt; \
&lt;platform&gt; &lt;host&gt; \
&lt;git repo&gt; [&lt;git dir&gt;]
diff --git a/doc/bmcp.html b/doc/bmcp.html
index f8ff755..de7f21b 100644
--- a/doc/bmcp.html
+++ b/doc/bmcp.html
@@ -48,122 +48,6 @@ successfully processed.
<!-- ---------------------------------------------------------------------------------- -->
<tr>
-<td class="requestName">AddBenchmark</td>
-<td class="requestDescr">
-Adds a new benchmark to the database.
-</td>
-
-<td>
-<pre>
-&lt;request type="AddBenchmark"&gt;
- &lt;benchmark testCase="..." testFunction="..."
- dataTag="..." /&gt;
-&lt;/request&gt;
-</pre>
-</td>
-
-<td>
-<pre>
-&lt;reply type="AddBenchmark" /&gt;
-</pre>
-</td>
-
-</tr>
-
-<!-- ---------------------------------------------------------------------------------- -->
-<tr>
-<td class="requestName">AddMetric</td>
-<td class="requestDescr">
-Adds a new metric to the database.
-</td>
-
-<td>
-<pre>
-&lt;request type="AddMetric"&gt;
- &lt;metric name="..." /&gt;
-&lt;/request&gt;
-</pre>
-</td>
-
-<td>
-<pre>
-&lt;reply type="AddMetric" /&gt;
-</pre>
-</td>
-
-</tr>
-
-<!-- ---------------------------------------------------------------------------------- -->
-<tr>
-<td class="requestName">AddPlatform</td>
-<td class="requestDescr">
-Adds a new platform to the database.
-</td>
-
-<td>
-<pre>
-&lt;request type="AddPlatform"&gt;
- &lt;platform name="..." /&gt;
-&lt;/request&gt;
-</pre>
-</td>
-
-<td>
-<pre>
-&lt;reply type="AddPlatform" /&gt;
-</pre>
-</td>
-
-</tr>
-
-<!-- ---------------------------------------------------------------------------------- -->
-<tr>
-<td class="requestName">AddHost</td>
-<td class="requestDescr">
-Adds a new host to the database.
-</td>
-
-<td>
-<pre>
-&lt;request type="AddHost"&gt;
- &lt;host name="..." /&gt;
-&lt;/request&gt;
-</pre>
-</td>
-
-<td>
-<pre>
-&lt;reply type="AddHost" /&gt;
-</pre>
-</td>
-
-</tr>
-
-<!-- ---------------------------------------------------------------------------------- -->
-<tr>
-<td class="requestName">AddBranch</td>
-<td class="requestDescr">
-Adds a new branch to the database.
-</td>
-
-<td>
-<pre>
- &lt;request type="AddBranch"&gt;
- &lt;branch gitRepo="..." gitBranch="..." /&gt;
- &lt;/request&gt;
-</pre>
-</td>
-
-<td>
-<pre>
-&lt;reply type="AddBranch" /&gt;
-</pre>
-</td>
-
-</tr>
-
-<!-- ---------------------------------------------------------------------------------- -->
-<tr>
<td class="requestName">AddResults</td>
<td class="requestDescr">
Adds new results to the database.
diff --git a/doc/notes.txt b/doc/notes.txt
index 0bbe65b..e5ed814 100644
--- a/doc/notes.txt
+++ b/doc/notes.txt
@@ -29,57 +29,7 @@ Note: The -sha1 option requires exact matching and is thus less powerful than -t
----------------------------------
-Use case 1: Add a benchmark:
-
- ./bmc add -benchmark <test case> <test function> <data tag>
-
- Example:
-
- ./bmc add -benchmark tst_QWidget updateOpaque 10x10x1
-
-----------------------------------
-Use case 2: Add a metric:
-
- ./bmc add -metric <metric>
-
- Note: walltime, cputicks, callgrind, and events should be added upon installation.
-
-----------------------------------
-Use case 3: Add a platform:
-
- ./bmc add -platform <platform>
-
- Notes:
-
- - The platform typically identifies a particular OS/compiler combination.
-
- - The official platforms supported by Qt (linux-g++, solaris-cc-64 etc.) should
- be added upon installation.
-
-----------------------------------
-Use case 4: Add a host:
-
- ./bmc add -host <host> [<details>]
-
- Note: The host identifies a physical machine.
-
- Example:
-
- ./bmc add -host barbarella
-
-----------------------------------
-Use case 5: Add a branch:
-
- ./bmc add -branch <git repo> <git branch>
-
- Note: qt/master, qt/45, qt/46, qt/... should be added upon installation.
-
- Example:
-
- ./bmc add -branch jasplins-qt master
-
-----------------------------------
-Use case 6: Add new results:
+Use case 1: Add new results:
./bmc add -results <xml file> <platform> <host> <git repo> [<git dir>]
@@ -112,7 +62,7 @@ Use case 6: Add new results:
./bmc add -results results.xml linux-g++ barbarella qt master $QTDIR
----------------------------------
-Use case 7: List available snapshots for a given branch:
+Use case 2: List available snapshots for a given branch:
./bmc list -snapshots BMCONTEXT <branch>
@@ -122,7 +72,7 @@ Use case 7: List available snapshots for a given branch:
linux-g++ barbarella qt master
----------------------------------
-Use case 8: List available benchmarks (subject to optional restrictions):
+Use case 3: List available benchmarks (subject to optional restrictions):
./bmc list -benchmarks [-metric <metric>] [-platform <platform>] [-host <host>] \
[-branch <branch>]
@@ -141,7 +91,7 @@ Use case 8: List available benchmarks (subject to optional restrictions):
-branch qt master
----------------------------------
-Use case 9: List available metrics (subject to optional restrictions):
+Use case 4: List available metrics (subject to optional restrictions):
./bmc list -metrics [-benchmark <test case> <test function> <data tag>] \
[-platform <platform>] [-host <host>] [-branch <branch>]
@@ -156,25 +106,25 @@ Use case 9: List available metrics (subject to optional restrictions):
-platform linux-g++ -host barbarella -branch qt master
----------------------------------
-Use case 10: List available platforms (subject to optional restrictions):
+Use case 5: List available platforms (subject to optional restrictions):
./bmc list -platforms [-benchmark <test case> <test function> <data tag>] \
[-metric <metric>] [-host <host>] [-branch <branch>]
----------------------------------
-Use case 11: List available hosts (subject to optional restrictions):
+Use case 6: List available hosts (subject to optional restrictions):
./bmc list -hosts [-benchmark <test case> <test function> <data tag>] \
[-metric <metric>] [-platform <platform>] [-branch <branch>]
----------------------------------
-Use case 12: List available branches (subject to optional restrictions):
+Use case 7: List available branches (subject to optional restrictions):
./bmc list -platforms [-benchmark <test case> <test function> <data tag>] \
[-metric <metric>] [-platform <platform>] [-host <host>]
----------------------------------
-Use case 13: Compare results as a history of a given branch since a given snapshot:
+Use case 8: Compare results as a history of a given branch since a given snapshot:
./bmc compare -history BMCONTEXT <branch> SNAPSHOT
@@ -194,7 +144,7 @@ Use case 13: Compare results as a history of a given branch since a given snapsh
linux-g++ barbarella qt master -sha1 3bad2f608813968d85c2ea51c1bd75dca7f7e22a
----------------------------------
-Use case 14: Compare the results of two branches:
+Use case 9: Compare the results of two branches:
./bmc compare -branches BMCONTEXT <branch1> SNAPSHOT1 <branch2> SNAPSHOT2
@@ -204,7 +154,7 @@ Use case 14: Compare the results of two branches:
linux-g++ barbarella qt 45 -timestamp last qt 46 -timestamp last
----------------------------------
-Use case 15: Compare a result of a given branch directly to an unregistered
+Use case 10: Compare a result of a given branch directly to an unregistered
result (i.e. one not yet in the database):
./bmc compare -direct BMCONTEXT <branch> SNAPSHOT (<value> <iterations>) | <xml file>