diff options
| author | jasplin <qt-info@nokia.com> | 2009-08-25 13:59:59 +0200 |
|---|---|---|
| committer | jasplin <qt-info@nokia.com> | 2009-08-25 13:59:59 +0200 |
| commit | 6eedfd10deee5935cfae24fae6d39d5ed91f6a3a (patch) | |
| tree | 604a488e460a0f563d27229048b34d45f5285f94 /doc | |
| parent | 0cd82cd145023f61675ed70b41ba941416c866f8 (diff) | |
Compacted description into a table.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/bmcp.html | 568 |
1 files changed, 326 insertions, 242 deletions
diff --git a/doc/bmcp.html b/doc/bmcp.html index 5f057ad..5eacd76 100644 --- a/doc/bmcp.html +++ b/doc/bmcp.html @@ -3,9 +3,11 @@ <head> <style type="text/css"> -//thead {background-color:#e5e5e5; text-align:left} +table {background-color:#f5f5f5; text-align:left} +th {vertical-align:top; padding:5px} +td {vertical-align:top; padding:5px} .requestName {color:#a0291b; font-size:18} -.requestDescr {color:#228822} +.requestDescr {color:#117711; min-width:200px} </style> </head> @@ -25,380 +27,462 @@ client. Each request or reply message consists of a header followed by a data part. The header consists of a single four-byte quint32 value (in big endian, -i.e. most significant byte first) that holds the number of bytes of the data -part. The data part is encoded as an XML structure that depends on the request -type. The XML structures for the individual request types are specified below. - - -<h3>Requests</h3> - -<!-- Describe how any reply message may have an optional error attribute --> -<!-- indicating an error ... 2 B DONE! --> +i.e. most significant byte first) that holds the size of the data part (in bytes). +The data part is encoded in XML as specified in the table below. <b>Note:</b> Any reply message may optionally contain an <i>error</i> attribute in its <reply> tag. If non-empty, the value of this attribute is an error message that describes the reason why the request could not be successfully processed. -<!-- ---------------------------------------------------------------------------------- --> -<hr /> +<br /> +<br /> -<h4 class="requestName">AddBenchmark</h4> +<table border=1> +<tr> + <th>Name</th> + <th>Description</th> + <th>Request message</th> + <th>Reply message</th> +</tr> -<p class="requestDescr"> -This request adds a new benchmark to the database. -</p> +<!-- ---------------------------------------------------------------------------------- --> +<tr> +<td class="requestName">AddBenchmark</td> +<td class="requestDescr"> +Adds a new benchmark to the database. +</td> +<td> <pre> - <request type="AddBenchmark"> - <benchmark testCase="..." testFunction="..." dataTag="..." /> - </request> +<request type="AddBenchmark"> + <benchmark testCase="..." testFunction="..." + dataTag="..." /> +</request> </pre> +</td> +<td> <pre> - <reply type="AddBenchmark" /> +<reply type="AddBenchmark" /> </pre> +</td> -<!-- ---------------------------------------------------------------------------------- --> -<hr /> - -<h4 class="requestName">AddMetric</h4> +</tr> -<p class="requestDescr"> -This request adds a new metric to the database. -</p> +<!-- ---------------------------------------------------------------------------------- --> +<tr> +<td class="requestName">AddMetric</td> +<td class="requestDescr"> +Adds a new metric to the database. +</td> +<td> <pre> - <request type="AddMetric"> - <metric name="..." /> - </request> +<request type="AddMetric"> + <metric name="..." /> +</request> </pre> +</td> +<td> <pre> - <reply type="AddMetric" /> +<reply type="AddMetric" /> </pre> +</td> -<!-- ---------------------------------------------------------------------------------- --> -<hr /> - -<h4 class="requestName">AddPlatform</h4> +</tr> -<p class="requestDescr"> -This request adds a new platform to the database. -</p> +<!-- ---------------------------------------------------------------------------------- --> +<tr> +<td class="requestName">AddPlatform</td> +<td class="requestDescr"> +Adds a new platform to the database. +</td> +<td> <pre> - <request type="AddPlatform"> - <platform name="..." /> - </request> +<request type="AddPlatform"> + <platform name="..." /> +</request> </pre> +</td> +<td> <pre> - <reply type="AddPlatform" /> +<reply type="AddPlatform" /> </pre> +</td> -<!-- ---------------------------------------------------------------------------------- --> -<hr /> - -<h4 class="requestName">AddHost</h4> +</tr> -<p class="requestDescr"> -This request adds a new host to the database. -</p> +<!-- ---------------------------------------------------------------------------------- --> +<tr> +<td class="requestName">AddHost</td> +<td class="requestDescr"> +Adds a new host to the database. +</td> +<td> <pre> - <request type="AddHost"> - <host name="..." /> - </request> +<request type="AddHost"> + <host name="..." /> +</request> </pre> +</td> +<td> <pre> - <reply type="AddHost" /> +<reply type="AddHost" /> </pre> +</td> -<!-- ---------------------------------------------------------------------------------- --> -<hr /> - -<h4 class="requestName">AddBranch</h4> +</tr> -<p class="requestDescr"> -This request adds a new branch to the database. -</p> +<!-- ---------------------------------------------------------------------------------- --> +<tr> +<td class="requestName">AddBranch</td> +<td class="requestDescr"> +Adds a new branch to the database. +</td> +<td> <pre> <request type="AddBranch"> <branch gitRepo="..." gitBranch="..." /> </request> </pre> +</td> +<td> <pre> - <reply type="AddBranch" /> +<reply type="AddBranch" /> </pre> +</td> -<!-- ---------------------------------------------------------------------------------- --> -<hr /> - -<h4 class="requestName">AddResults</h4> +</tr> -<p class="requestDescr"> -This request adds new results to the database. -</p> +<!-- ---------------------------------------------------------------------------------- --> +<tr> +<td class="requestName">AddResults</td> +<td class="requestDescr"> +Adds new results to the database. +</td> +<td> <pre> - <request type="AddResults"> - <context platform="..." host="..." gitRepo="..." gitBranch="..." - timestamp="..." sha1="..." testCase="..." /> - <testFunction name="..."> - <dataTag name="..." metric="..." value"..." iterations="..." /> - ... - </testFunction> - ... +<request type="AddResults"> + <context platform="..." host="..." + gitRepo="..." gitBranch="..." + timestamp="..." sha1="..." + testCase="..." /> + <testFunction name="..."> + <dataTag name="..." metric="..." + value"..." iterations="..." /> ... - </request> + </testFunction> + ... +</request> </pre> +</td> -<pre> - <reply type="AddResults" /> -</pre> +<td> +<reply type="AddResults" /> +</td> -<!-- ---------------------------------------------------------------------------------- --> -<hr /> +</tr> -<h4 class="requestName">ListSnapshots</h4> - -<p class="requestDescr"> -This request lists snapshots available for a particular context. -</p> +<!-- ---------------------------------------------------------------------------------- --> +<tr> +<td class="requestName">ListSnapshots</td> +<td class="requestDescr"> +Lists snapshots available for a particular context. +</td> +<td> <pre> - <request type="ListSnapshots"> - <context testCase="..." testFunction="..." dataTag="..." metric="..." platform="..." - host="..." gitRepo="..." gitBranch="..." /> - </request> +<request type="ListSnapshots"> + <context testCase="..." testFunction="..." + dataTag="..." metric="..." + platform="..." host="..." + gitRepo="..." gitBranch="..." /> +</request> </pre> +</td> +<td> <pre> - <reply type="ListSnapshots"> - <snapshot timestamp="..." sha1="..." /> - <snapshot timestamp="..." sha1="..." /> - ... - </reply> +<reply type="ListSnapshots"> + <snapshot timestamp="..." sha1="..." /> + <snapshot timestamp="..." sha1="..." /> + ... +</reply> </pre> +</td> -<!-- ---------------------------------------------------------------------------------- --> -<hr /> +</tr> -<h4 class="requestName">ListBenchmarks</h4> - -<p class="requestDescr"> -This request lists available benchmarks. One or more additional entity values -(metric, platform, host, or git repo/branch) may be specified as non-empty values to +<!-- ---------------------------------------------------------------------------------- --> +<tr> +<td class="requestName">ListBenchmarks</td> +<td class="requestDescr"> +Lists available benchmarks. One or more additional entity values (metric, +platform, host, or git repo/branch) may be specified as non-empty values to restrict the output to only those benchmarks for which at least one result exists in combination with that combination of values. If all additional entity values are empty, the output will include all available benchmarks, even those that haven't been associated with any result yet. -</p> +</td> +<td> <pre> - <request type="ListBenchmarks"> - <context metric="..." platform="..." host="..." gitRepo="..." gitBranch="..." /> - </request> +<request type="ListBenchmarks"> + <context metric="..." platform="..." + host="..." gitRepo="..." + gitBranch="..." /> +</request> </pre> +</td> +<td> <pre> - <reply type="ListBenchmarks"> - <benchmark testCase="..." testFunction="..." dataTag="..." /> - <benchmark testCase="..." testFunction="..." dataTag="..." /> - ... - </reply> +<reply type="ListBenchmarks"> + <benchmark testCase="..." testFunction="..." + dataTag="..." /> + <benchmark testCase="..." testFunction="..." + dataTag="..." /> + ... +</reply> </pre> +</td> -<!-- ---------------------------------------------------------------------------------- --> -<hr /> +</tr> -<h4 class="requestName">ListMetrics</h4> - -<p class="requestDescr"> -This request behaves similarly to ListBenchmarks (see this). -</p> +<!-- ---------------------------------------------------------------------------------- --> +<tr> +<td class="requestName">ListMetrics</td> +<td class="requestDescr"> +Behaves similarly to ListBenchmarks (see this). +</td> +<td> <pre> - <request type="ListMetrics"> - <context testCase="..." testFunction="..." dataTag="..." platform="..." host="..." - gitRepo="..." gitBranch="..." /> - </request> +<request type="ListMetrics"> + <context testCase="..." testFunction="..." + dataTag="..." platform="..." + host="..." gitRepo="..." + gitBranch="..." /> +</request> </pre> +</td> +<td> <pre> - <reply type="ListMetrics"> - <metric name="..." /> - <metric name="..." /> - ... - </reply> +<reply type="ListMetrics"> + <metric name="..." /> + <metric name="..." /> + ... +</reply> </pre> +</td> -<!-- ---------------------------------------------------------------------------------- --> -<hr /> +</tr> -<h4 class="requestName">ListPlatforms</h4> - -<p class="requestDescr"> -This request behaves similarly to ListBenchmarks (see this). -</p> +<!-- ---------------------------------------------------------------------------------- --> +<tr> +<td class="requestName">ListPlatforms</td> +<td class="requestDescr"> +Behaves similarly to ListBenchmarks (see this). +</td> +<td> <pre> - <request type="ListPlatforms"> - <context testCase="..." testFunction="..." dataTag="..." metric="..." host="..." - gitRepo="..." gitBranch="..." /> - </request> +<request type="ListPlatforms"> + <context testCase="..." testFunction="..." + dataTag="..." metric="..." + host="..." gitRepo="..." + gitBranch="..." /> +</request> </pre> +</td> +<td> <pre> - <reply type="ListPlatforms"> - <platform name="..." /> - <platform name="..." /> - ... - </reply> +<reply type="ListPlatforms"> + <platform name="..." /> + <platform name="..." /> + ... +</reply> </pre> +</td> -<!-- ---------------------------------------------------------------------------------- --> -<hr /> +</tr> -<h4 class="requestName">ListHosts</h4> - -<p class="requestDescr"> -This request behaves similarly to ListBenchmarks (see this). -</p> +<!-- ---------------------------------------------------------------------------------- --> +<tr> +<td class="requestName">ListHosts</td> +<td class="requestDescr"> +Behaves similarly to ListBenchmarks (see this). +</td> +<td> <pre> - <request type="ListHosts"> - <context testCase="..." testFunction="..." dataTag="..." metric="..." platform="..." - gitRepo="..." gitBranch="..." /> - </request> +<request type="ListHosts"> + <context testCase="..." testFunction="..." + dataTag="..." metric="..." + platform="..." gitRepo="..." + gitBranch="..." /> +</request> </pre> +</td> +<td> <pre> - <reply type="ListHosts"> - <host name="..." /> - <host name="..." /> - ... - </reply> +<reply type="ListHosts"> + <host name="..." /> + <host name="..." /> + ... +</reply> </pre> +</td> -<!-- ---------------------------------------------------------------------------------- --> -<hr /> +</tr> -<h4 class="requestName">ListBranches</h4> - -<p class="requestDescr"> -This request behaves similarly to ListBenchmarks (see this). -</p> +<!-- ---------------------------------------------------------------------------------- --> +<tr> +<td class="requestName">ListBranches</td> +<td class="requestDescr"> +Behaves similarly to ListBenchmarks (see this). +</td> +<td> <pre> - <request type="ListBranches"> - <context testCase="..." testFunction="..." dataTag="..." metric="..." platform="..." - host="..." /> - </request> +<request type="ListBranches"> + <context testCase="..." testFunction="..." + dataTag="..." metric="..." + platform="..." host="..." /> +</request> </pre> +</td> +<td> <pre> - <reply type="ListBranches"> - <branch gitRepo="..." gitBranch="..." /> - <branch gitRepo="..." gitBranch="..." /> - ... - </reply> -</pre> +<reply type="ListBranches"> + <branch gitRepo="..." gitBranch="..." /> + <branch gitRepo="..." gitBranch="..." /> + ... +</reply> +</td> -<!-- ---------------------------------------------------------------------------------- --> -<hr /> - -<h4 class="requestName">CompareHistory</h4> - -<p class="requestDescr"> -This request compares results as a history for a particular context since a -particular snapshot. -</p> +</tr> -<p class="requestDescr"> +<!-- ---------------------------------------------------------------------------------- --> +<tr> +<td class="requestName">CompareHistory</td> +<td class="requestDescr"> +Compares results as a history for a particular context since a particular snapshot. <b>Note:</b> 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> may be used to refer to the first and last available result respectively. Otherwise, <i>timestamp</i> refers to the earliest result that is not earlier than the specified value. -</p> +</td> +<td> <pre> - <request type="CompareHistory"> - <context testCase="..." testFunction="..." dataTag="..." metric="..." platform="..." - host="..." gitRepo="..." gitBranch="..." timestamp="..." sha1="..." /> - </request> +<request type="CompareHistory"> + <context testCase="..." testFunction="..." + dataTag="..." metric="..." + platform="..." host="..." + gitRepo="..." gitBranch="..." + timestamp="..." sha1="..." /> +</request> </pre> +</td> +<td> <pre> - <reply type="CompareHistory"> - <result timestamp="..." sha1="..." value="..." iterations="..." /> - <result timestamp="..." sha1="..." value="..." iterations="..." /> - ... - </reply> +<reply type="CompareHistory"> + <result timestamp="..." sha1="..." + value="..." iterations="..." /> + <result timestamp="..." sha1="..." + value="..." iterations="..." /> + ... +</reply> </pre> +</td> -<!-- ---------------------------------------------------------------------------------- --> -<hr /> - -<h4 class="requestName">CompareBranches</h4> - -<p class="requestDescr"> -This request compares the results of two branches. -</p> - -<p class="requestDescr"> -See note above regarding semantics of the timestamp and sha1 attributes. -</p> +</tr> +<!-- ---------------------------------------------------------------------------------- --> +<tr> +<td class="requestName">CompareBranches</td> +<td class="requestDescr"> +Compares the results of two branches. See note above regarding semantics of +the timestamp and sha1 attributes. +</td> + +<td> <pre> - <request type="CompareBranches"> - <context testCase="..." testFunction="..." dataTag="..." metric="..." platform="..." - host="..." - gitRepo1="..." gitBranch1="..." timestamp1="..." sha11="..." - gitRepo2="..." gitBranch2="..." timestamp2="..." sha12="..." /> - </request> +<request type="CompareBranches"> + <context testCase="..." testFunction="..." + dataTag="..." metric="..." + platform="..." host="..." + gitRepo1="..." gitBranch1="..." + timestamp1="..." sha11="..." + gitRepo2="..." gitBranch2="..." + timestamp2="..." sha12="..." /> +</request> </pre> +</td> +<td> <pre> - <reply type="CompareBranches"> - <result timestamp="..." sha1="..." value="..." iterations="..." /> - <result timestamp="..." sha1="..." value="..." iterations="..." /> - </reply> +<reply type="CompareBranches"> + <result timestamp="..." sha1="..." + value="..." iterations="..." /> + <result timestamp="..." sha1="..." + value="..." iterations="..." /> +</reply> </pre> +</td> -<!-- ---------------------------------------------------------------------------------- --> -<hr /> - -<h4 class="requestName">CompareDirect</h4> - -<p class="requestDescr"> -This request compares a result in the database to an explicitly given result. -</p> - -<p class="requestDescr"> -See note above regarding semantics of the timestamp and sha1 attributes. -</p> +</tr> +<!-- ---------------------------------------------------------------------------------- --> +<tr> +<td class="requestName">CompareDirect</td> +<td class="requestDescr"> +Compares a result in the database to an explicitly given result. See note +above regarding semantics of the timestamp and sha1 attributes. +</td> + +<td> <pre> - <request type="CompareDirect"> - <context testCase="..." testFunction="..." dataTag="..." metric="..." platform="..." - host="..." - gitRepo="..." gitBranch="..." timestamp="..." sha1="..." - value="..." iterations="..." /> - </request> +<request type="CompareDirect"> + <context testCase="..." testFunction="..." + dataTag="..." metric="..." + platform="..." host="..." + gitRepo="..." gitBranch="..." + timestamp="..." sha1="..." + value="..." iterations="..." /> +</request> </pre> +</td> +<td> <pre> - <reply type="CompareDirect"> - <result timestamp="..." sha1="..." value="..." iterations="..." /> - <result value="..." iterations="..." /> - </reply> +<reply type="CompareDirect"> + <result timestamp="..." sha1="..." + value="..." iterations="..." /> + <result value="..." iterations="..." /> +</reply> </pre> +</td> + +</tr> + +</table> </body> </html> |