diff options
author | jasplin <qt-info@nokia.com> | 2009-08-17 09:57:25 +0200 |
---|---|---|
committer | jasplin <qt-info@nokia.com> | 2009-08-17 09:57:25 +0200 |
commit | 8d5db119ab71ed62b7b4adf6aa4b8530ab7f5e49 (patch) | |
tree | ee21941305b4e4650c37763a6d52461db53849ad /doc | |
parent | df99e9ef6e005d36aa16ceabe1838f61b6abece9 (diff) |
Updates.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/bmcp.html | 193 | ||||
-rw-r--r-- | doc/notes.txt | 140 |
2 files changed, 167 insertions, 166 deletions
diff --git a/doc/bmcp.html b/doc/bmcp.html index 28dfa26..893e85a 100644 --- a/doc/bmcp.html +++ b/doc/bmcp.html @@ -392,29 +392,26 @@ class="alias">TESTCASERESULTS</td><td></td><td></td></tr> <hr /> <p class="msgDescr"> -This request compares results as a history of a particular BMCONTEXT/BRANCH -combination since a particular SNAPSHOT. +This request lists all snapshots available for a particular BMCONTEXT/BRANCH combination. </p> -<h4 class="msgName">CompareHistoryRequest</h4> +<h4 class="msgName">ListSnapshotsRequest</h4> <table border=0> <thead><tr><th>No. of bytes</th><th>Type</th><th>Value</th><th>Description</th></tr></thead> <tr><td>1</td><td>U8</td><td>14</td><td>message type</td></tr> <tr><td>BMCONTEXT size</td><td class="alias">BMCONTEXT</td><td></td><td></td></tr> <tr><td>BRANCH size</td><td class="alias">BRANCH</td><td></td><td></td></tr> -<tr><td>SNAPSHOT size</td><td class="alias">SNAPSHOT</td><td></td><td></td></tr> </table> -<h4 class="msgName">CompareHistoryReply</h4> +<h4 class="msgName">ListSnapshotsReply</h4> <table border=0> <thead><tr><th>No. of bytes</th><th>Type</th><th>Value</th><th>Description</th></tr></thead> <tr><td>1</td><td>U8</td><td>15</td><td>message type</td></tr> -<tr><td>4</td><td>U32</td><td></td><td>history size</td></tr> -<tr><td>SNAPSHOTRESULT size</td><td -class="alias">SNAPSHOTRESULT</td><td></td><td>result 1</td></tr> -<tr><td>SNAPSHOTRESULT size</td><td -class="alias">SNAPSHOTRESULT</td><td></td><td>result 2</td></tr> +<tr><td>1</td><td>U32</td><td></td><td>n</td></tr> +<tr><td>SNAPSHOT size</td><td class="alias">SNAPSHOT</td><td></td><td>item 1</td></tr> +<tr><td>SNAPSHOT size</td><td class="alias">SNAPSHOT</td><td></td><td>item 2</td></tr> <tr><td>...</td></tr> +<tr><td>SNAPSHOT size</td><td class="alias">SNAPSHOT</td><td></td><td>item n</td></tr> </table> @@ -422,32 +419,33 @@ class="alias">SNAPSHOTRESULT</td><td></td><td>result 2</td></tr> <hr /> <p class="msgDescr"> -This request compares the results of two branches. +This request lists available benchmarks. One or more additional entity values +(metric, platform, host, or 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> -<h4 class="msgName">CompareBranchesRequest</h4> +<h4 class="msgName">ListBenchmarksRequest</h4> <table border=0> <thead><tr><th>No. of bytes</th><th>Type</th><th>Value</th><th>Description</th></tr></thead> <tr><td>1</td><td>U8</td><td>16</td><td>message type</td></tr> -<tr><td>BMCONTEXT size</td><td class="alias">BMCONTEXT</td><td></td><td></td></tr> -<tr><td>BRANCH size</td><td -class="alias">BRANCH</td><td></td><td>branch 1</td></tr> -<tr><td>SNAPSHOT size</td><td -class="alias">SNAPSHOT</td><td></td><td>snapshot 1</td></tr> -<tr><td>BRANCH size</td><td -class="alias">BRANCH</td><td></td><td>branch 2</td></tr> -<tr><td>SNAPSHOT size</td><td -class="alias">SNAPSHOT</td><td></td><td>snapshot 2</td></tr> +<tr><td>METRIC size</td><td class="alias">METRIC</td><td></td><td></td></tr> +<tr><td>PLATFORM size</td><td class="alias">PLATFORM</td><td></td><td></td></tr> +<tr><td>HOST size</td><td class="alias">HOST</td><td></td><td></td></tr> +<tr><td>BRANCH size</td><td class="alias">BRANCH</td><td></td><td></td></tr> </table> -<h4 class="msgName">CompareBranchesReply</h4> +<h4 class="msgName">ListBenchmarksReply</h4> <table border=0> <thead><tr><th>No. of bytes</th><th>Type</th><th>Value</th><th>Description</th></tr></thead> <tr><td>1</td><td>U8</td><td>17</td><td>message type</td></tr> -<tr><td>SNAPSHOTRESULT size</td><td -class="alias">SNAPSHOTRESULT</td><td></td><td>result 1</td></tr> -<tr><td>SNAPSHOTRESULT size</td><td -class="alias">SNAPSHOTRESULT</td><td></td><td>result 2</td></tr> +<tr><td>1</td><td>U32</td><td></td><td>n</td></tr> +<tr><td>BENCHMARK size</td><td class="alias">BENCHMARK</td><td></td><td>item 1</td></tr> +<tr><td>BENCHMARK size</td><td class="alias">BENCHMARK</td><td></td><td>item 2</td></tr> +<tr><td>...</td></tr> +<tr><td>BENCHMARK size</td><td class="alias">BENCHMARK</td><td></td><td>item n</td></tr> </table> @@ -455,28 +453,28 @@ class="alias">SNAPSHOTRESULT</td><td></td><td>result 2</td></tr> <hr /> <p class="msgDescr"> -This request compares a result in the database to an explicitly given result. +This request behaves similarly to ListBenchmarks* (see this). </p> -<h4 class="msgName">CompareDirectRequest</h4> +<h4 class="msgName">ListMetricsRequest</h4> <table border=0> <thead><tr><th>No. of bytes</th><th>Type</th><th>Value</th><th>Description</th></tr></thead> <tr><td>1</td><td>U8</td><td>18</td><td>message type</td></tr> -<tr><td>BMCONTEXT size</td><td class="alias">BMCONTEXT</td><td></td><td></td></tr> +<tr><td>BENCHMARK size</td><td class="alias">BENCHMARK</td><td></td><td></td></tr> +<tr><td>PLATFORM size</td><td class="alias">PLATFORM</td><td></td><td></td></tr> +<tr><td>HOST size</td><td class="alias">HOST</td><td></td><td></td></tr> <tr><td>BRANCH size</td><td class="alias">BRANCH</td><td></td><td></td></tr> -<tr><td>SNAPSHOT size</td><td class="alias">SNAPSHOT</td><td></td><td></td></tr> -<tr><td>RESULT size</td><td class="alias">RESULT</td><td></td><td></td></tr> </table> -<h4 class="msgName">CompareDirectReply</h4> +<h4 class="msgName">ListMetricsReply</h4> <table border=0> <thead><tr><th>No. of bytes</th><th>Type</th><th>Value</th><th>Description</th></tr></thead> <tr><td>1</td><td>U8</td><td>19</td><td>message type</td></tr> -<tr><td>SNAPSHOTRESULT size</td><td -class="alias">SNAPSHOTRESULT</td><td></td><td></td></tr> -<tr><td>RESULT size</td><td -class="alias">RESULT</td><td></td><td>(identical to the one in the -request)</td></tr> +<tr><td>1</td><td>U32</td><td></td><td>n</td></tr> +<tr><td>METRIC size</td><td class="alias">METRIC</td><td></td><td>item 1</td></tr> +<tr><td>METRIC size</td><td class="alias">METRIC</td><td></td><td>item 2</td></tr> +<tr><td>...</td></tr> +<tr><td>METRIC size</td><td class="alias">METRIC</td><td></td><td>item n</td></tr> </table> @@ -484,26 +482,28 @@ request)</td></tr> <hr /> <p class="msgDescr"> -This request lists all snapshots available for a particular BMCONTEXT/BRANCH combination. +This request behaves similarly to ListBenchmarks* (see this). </p> -<h4 class="msgName">ListSnapshotsRequest</h4> +<h4 class="msgName">ListPlatformsRequest</h4> <table border=0> <thead><tr><th>No. of bytes</th><th>Type</th><th>Value</th><th>Description</th></tr></thead> <tr><td>1</td><td>U8</td><td>20</td><td>message type</td></tr> -<tr><td>BMCONTEXT size</td><td class="alias">BMCONTEXT</td><td></td><td></td></tr> +<tr><td>BENCHMARK size</td><td class="alias">BENCHMARK</td><td></td><td></td></tr> +<tr><td>METRIC size</td><td class="alias">METRIC</td><td></td><td></td></tr> +<tr><td>HOST size</td><td class="alias">HOST</td><td></td><td></td></tr> <tr><td>BRANCH size</td><td class="alias">BRANCH</td><td></td><td></td></tr> </table> -<h4 class="msgName">ListSnapshotsReply</h4> +<h4 class="msgName">ListPlatformsReply</h4> <table border=0> <thead><tr><th>No. of bytes</th><th>Type</th><th>Value</th><th>Description</th></tr></thead> <tr><td>1</td><td>U8</td><td>21</td><td>message type</td></tr> <tr><td>1</td><td>U32</td><td></td><td>n</td></tr> -<tr><td>SNAPSHOT size</td><td class="alias">SNAPSHOT</td><td></td><td>item 1</td></tr> -<tr><td>SNAPSHOT size</td><td class="alias">SNAPSHOT</td><td></td><td>item 2</td></tr> +<tr><td>PLATFORM size</td><td class="alias">PLATFORM</td><td></td><td>item 1</td></tr> +<tr><td>PLATFORM size</td><td class="alias">PLATFORM</td><td></td><td>item 2</td></tr> <tr><td>...</td></tr> -<tr><td>SNAPSHOT size</td><td class="alias">SNAPSHOT</td><td></td><td>item n</td></tr> +<tr><td>PLATFORM size</td><td class="alias">PLATFORM</td><td></td><td>item n</td></tr> </table> @@ -511,33 +511,28 @@ This request lists all snapshots available for a particular BMCONTEXT/BRANCH com <hr /> <p class="msgDescr"> -This request lists available benchmarks. One or more additional entity values -(metric, platform, host, or 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. +This request behaves similarly to ListBenchmarks* (see this). </p> -<h4 class="msgName">ListBenchmarksRequest</h4> +<h4 class="msgName">ListHostsRequest</h4> <table border=0> <thead><tr><th>No. of bytes</th><th>Type</th><th>Value</th><th>Description</th></tr></thead> <tr><td>1</td><td>U8</td><td>22</td><td>message type</td></tr> +<tr><td>BENCHMARK size</td><td class="alias">BENCHMARK</td><td></td><td></td></tr> <tr><td>METRIC size</td><td class="alias">METRIC</td><td></td><td></td></tr> <tr><td>PLATFORM size</td><td class="alias">PLATFORM</td><td></td><td></td></tr> -<tr><td>HOST size</td><td class="alias">HOST</td><td></td><td></td></tr> <tr><td>BRANCH size</td><td class="alias">BRANCH</td><td></td><td></td></tr> </table> -<h4 class="msgName">ListBenchmarksReply</h4> +<h4 class="msgName">ListHostsReply</h4> <table border=0> <thead><tr><th>No. of bytes</th><th>Type</th><th>Value</th><th>Description</th></tr></thead> <tr><td>1</td><td>U8</td><td>23</td><td>message type</td></tr> <tr><td>1</td><td>U32</td><td></td><td>n</td></tr> -<tr><td>BENCHMARK size</td><td class="alias">BENCHMARK</td><td></td><td>item 1</td></tr> -<tr><td>BENCHMARK size</td><td class="alias">BENCHMARK</td><td></td><td>item 2</td></tr> +<tr><td>HOST size</td><td class="alias">HOST</td><td></td><td>item 1</td></tr> +<tr><td>HOST size</td><td class="alias">HOST</td><td></td><td>item 2</td></tr> <tr><td>...</td></tr> -<tr><td>BENCHMARK size</td><td class="alias">BENCHMARK</td><td></td><td>item n</td></tr> +<tr><td>HOST size</td><td class="alias">HOST</td><td></td><td>item n</td></tr> </table> @@ -548,25 +543,25 @@ even those that haven't been associated with any result yet. This request behaves similarly to ListBenchmarks* (see this). </p> -<h4 class="msgName">ListMetricsRequest</h4> +<h4 class="msgName">ListBranchesRequest</h4> <table border=0> <thead><tr><th>No. of bytes</th><th>Type</th><th>Value</th><th>Description</th></tr></thead> <tr><td>1</td><td>U8</td><td>24</td><td>message type</td></tr> <tr><td>BENCHMARK size</td><td class="alias">BENCHMARK</td><td></td><td></td></tr> +<tr><td>METRIC size</td><td class="alias">METRIC</td><td></td><td></td></tr> <tr><td>PLATFORM size</td><td class="alias">PLATFORM</td><td></td><td></td></tr> <tr><td>HOST size</td><td class="alias">HOST</td><td></td><td></td></tr> -<tr><td>BRANCH size</td><td class="alias">BRANCH</td><td></td><td></td></tr> </table> -<h4 class="msgName">ListMetricsReply</h4> +<h4 class="msgName">ListBranchesReply</h4> <table border=0> <thead><tr><th>No. of bytes</th><th>Type</th><th>Value</th><th>Description</th></tr></thead> <tr><td>1</td><td>U8</td><td>25</td><td>message type</td></tr> <tr><td>1</td><td>U32</td><td></td><td>n</td></tr> -<tr><td>METRIC size</td><td class="alias">METRIC</td><td></td><td>item 1</td></tr> -<tr><td>METRIC size</td><td class="alias">METRIC</td><td></td><td>item 2</td></tr> +<tr><td>BRANCH size</td><td class="alias">BRANCH</td><td></td><td>item 1</td></tr> +<tr><td>BRANCH size</td><td class="alias">BRANCH</td><td></td><td>item 2</td></tr> <tr><td>...</td></tr> -<tr><td>METRIC size</td><td class="alias">METRIC</td><td></td><td>item n</td></tr> +<tr><td>BRANCH size</td><td class="alias">BRANCH</td><td></td><td>item n</td></tr> </table> @@ -574,28 +569,29 @@ This request behaves similarly to ListBenchmarks* (see this). <hr /> <p class="msgDescr"> -This request behaves similarly to ListBenchmarks* (see this). +This request compares results as a history of a particular BMCONTEXT/BRANCH +combination since a particular SNAPSHOT. </p> -<h4 class="msgName">ListPlatformsRequest</h4> +<h4 class="msgName">CompareHistoryRequest</h4> <table border=0> <thead><tr><th>No. of bytes</th><th>Type</th><th>Value</th><th>Description</th></tr></thead> <tr><td>1</td><td>U8</td><td>26</td><td>message type</td></tr> -<tr><td>BENCHMARK size</td><td class="alias">BENCHMARK</td><td></td><td></td></tr> -<tr><td>METRIC size</td><td class="alias">METRIC</td><td></td><td></td></tr> -<tr><td>HOST size</td><td class="alias">HOST</td><td></td><td></td></tr> +<tr><td>BMCONTEXT size</td><td class="alias">BMCONTEXT</td><td></td><td></td></tr> <tr><td>BRANCH size</td><td class="alias">BRANCH</td><td></td><td></td></tr> +<tr><td>SNAPSHOT size</td><td class="alias">SNAPSHOT</td><td></td><td></td></tr> </table> -<h4 class="msgName">ListPlatformsReply</h4> +<h4 class="msgName">CompareHistoryReply</h4> <table border=0> <thead><tr><th>No. of bytes</th><th>Type</th><th>Value</th><th>Description</th></tr></thead> <tr><td>1</td><td>U8</td><td>27</td><td>message type</td></tr> -<tr><td>1</td><td>U32</td><td></td><td>n</td></tr> -<tr><td>PLATFORM size</td><td class="alias">PLATFORM</td><td></td><td>item 1</td></tr> -<tr><td>PLATFORM size</td><td class="alias">PLATFORM</td><td></td><td>item 2</td></tr> +<tr><td>4</td><td>U32</td><td></td><td>history size</td></tr> +<tr><td>SNAPSHOTRESULT size</td><td +class="alias">SNAPSHOTRESULT</td><td></td><td>result 1</td></tr> +<tr><td>SNAPSHOTRESULT size</td><td +class="alias">SNAPSHOTRESULT</td><td></td><td>result 2</td></tr> <tr><td>...</td></tr> -<tr><td>PLATFORM size</td><td class="alias">PLATFORM</td><td></td><td>item n</td></tr> </table> @@ -603,28 +599,32 @@ This request behaves similarly to ListBenchmarks* (see this). <hr /> <p class="msgDescr"> -This request behaves similarly to ListBenchmarks* (see this). +This request compares the results of two branches. </p> -<h4 class="msgName">ListHostsRequest</h4> +<h4 class="msgName">CompareBranchesRequest</h4> <table border=0> <thead><tr><th>No. of bytes</th><th>Type</th><th>Value</th><th>Description</th></tr></thead> <tr><td>1</td><td>U8</td><td>28</td><td>message type</td></tr> -<tr><td>BENCHMARK size</td><td class="alias">BENCHMARK</td><td></td><td></td></tr> -<tr><td>METRIC size</td><td class="alias">METRIC</td><td></td><td></td></tr> -<tr><td>PLATFORM size</td><td class="alias">PLATFORM</td><td></td><td></td></tr> -<tr><td>BRANCH size</td><td class="alias">BRANCH</td><td></td><td></td></tr> +<tr><td>BMCONTEXT size</td><td class="alias">BMCONTEXT</td><td></td><td></td></tr> +<tr><td>BRANCH size</td><td +class="alias">BRANCH</td><td></td><td>branch 1</td></tr> +<tr><td>SNAPSHOT size</td><td +class="alias">SNAPSHOT</td><td></td><td>snapshot 1</td></tr> +<tr><td>BRANCH size</td><td +class="alias">BRANCH</td><td></td><td>branch 2</td></tr> +<tr><td>SNAPSHOT size</td><td +class="alias">SNAPSHOT</td><td></td><td>snapshot 2</td></tr> </table> -<h4 class="msgName">ListHostsReply</h4> +<h4 class="msgName">CompareBranchesReply</h4> <table border=0> <thead><tr><th>No. of bytes</th><th>Type</th><th>Value</th><th>Description</th></tr></thead> <tr><td>1</td><td>U8</td><td>29</td><td>message type</td></tr> -<tr><td>1</td><td>U32</td><td></td><td>n</td></tr> -<tr><td>HOST size</td><td class="alias">HOST</td><td></td><td>item 1</td></tr> -<tr><td>HOST size</td><td class="alias">HOST</td><td></td><td>item 2</td></tr> -<tr><td>...</td></tr> -<tr><td>HOST size</td><td class="alias">HOST</td><td></td><td>item n</td></tr> +<tr><td>SNAPSHOTRESULT size</td><td +class="alias">SNAPSHOTRESULT</td><td></td><td>result 1</td></tr> +<tr><td>SNAPSHOTRESULT size</td><td +class="alias">SNAPSHOTRESULT</td><td></td><td>result 2</td></tr> </table> @@ -632,29 +632,30 @@ This request behaves similarly to ListBenchmarks* (see this). <hr /> <p class="msgDescr"> -This request behaves similarly to ListBenchmarks* (see this). +This request compares a result in the database to an explicitly given result. </p> -<h4 class="msgName">ListBranchesRequest</h4> +<h4 class="msgName">CompareDirectRequest</h4> <table border=0> <thead><tr><th>No. of bytes</th><th>Type</th><th>Value</th><th>Description</th></tr></thead> <tr><td>1</td><td>U8</td><td>30</td><td>message type</td></tr> -<tr><td>BENCHMARK size</td><td class="alias">BENCHMARK</td><td></td><td></td></tr> -<tr><td>METRIC size</td><td class="alias">METRIC</td><td></td><td></td></tr> -<tr><td>PLATFORM size</td><td class="alias">PLATFORM</td><td></td><td></td></tr> -<tr><td>HOST size</td><td class="alias">HOST</td><td></td><td></td></tr> +<tr><td>BMCONTEXT size</td><td class="alias">BMCONTEXT</td><td></td><td></td></tr> +<tr><td>BRANCH size</td><td class="alias">BRANCH</td><td></td><td></td></tr> +<tr><td>SNAPSHOT size</td><td class="alias">SNAPSHOT</td><td></td><td></td></tr> +<tr><td>RESULT size</td><td class="alias">RESULT</td><td></td><td></td></tr> </table> -<h4 class="msgName">ListBranchesReply</h4> +<h4 class="msgName">CompareDirectReply</h4> <table border=0> <thead><tr><th>No. of bytes</th><th>Type</th><th>Value</th><th>Description</th></tr></thead> <tr><td>1</td><td>U8</td><td>31</td><td>message type</td></tr> -<tr><td>1</td><td>U32</td><td></td><td>n</td></tr> -<tr><td>BRANCH size</td><td class="alias">BRANCH</td><td></td><td>item 1</td></tr> -<tr><td>BRANCH size</td><td class="alias">BRANCH</td><td></td><td>item 2</td></tr> -<tr><td>...</td></tr> -<tr><td>BRANCH size</td><td class="alias">BRANCH</td><td></td><td>item n</td></tr> +<tr><td>SNAPSHOTRESULT size</td><td +class="alias">SNAPSHOTRESULT</td><td></td><td></td></tr> +<tr><td>RESULT size</td><td +class="alias">RESULT</td><td></td><td>(identical to the one in the +request)</td></tr> </table> + </body> </html> diff --git a/doc/notes.txt b/doc/notes.txt index c2c9201..aeb2d53 100644 --- a/doc/notes.txt +++ b/doc/notes.txt @@ -81,30 +81,30 @@ Use case 5: Add a branch: ---------------------------------- Use case 6: Add new results: - ./bmc add -results <xml file> <platform> <host> <product git repo> [<product git dir>] + ./bmc add -results <xml file> <platform> <host> <git repo> [<git dir>] Notes: - <xml file> must (essentially) be of the same format as the one being dumped by QTestLib. - - <product git dir> must refer to a directory accessible from the local + - <git dir> must refer to a directory accessible from the local file system and the git command needs to be installed (i.e. the program - needs to run git commands from <product git dir>). - By default, <product git dir> is the current directory. + needs to run git commands from <git dir>). + By default, <git dir> is the current directory. - The new results are assumed to have been generated using a product built from a clean checkout of the current head commit of the current git branch - in <product git dir>. + in <git dir>. - The sha1 to be stored in the database is assumed to be the current head commit in - <product git dir> (extracted running 'git log -1 HEAD --pretty=format:"%H"'). + <git dir> (extracted running 'git log -1 HEAD --pretty=format:"%H"'). - The timestamp to be stored in the database is the Unix timestamp of the committer date (extracted running 'git log -1 HEAD --pretty=format:"%ct"'). - - <product git repo> must be passed explicitly since it cannot in general - be derived from <product git dir> (e.g. in the case of a local, standalone + - <git repo> must be passed explicitly since it cannot in general + be derived from <git dir> (e.g. in the case of a local, standalone repository). Example: @@ -112,113 +112,113 @@ Use case 6: Add new results: ./bmc add -results results.xml linux-g++ barbarella qt master $QTDIR ---------------------------------- -Use case 7: Compare results as a history of a given branch since a given snapshot: +Use case 7: List available snapshots for a given branch: - ./bmc compare -history BMCONTEXT <branch> SNAPSHOT + ./bmc list -snapshots BMCONTEXT <branch> - Example 1: + Example: - ./bmc compare -history tst_QWidget updateOpaque 10x10x1 walltime \ - linux-g++ barbarella qt master -timestamp first + ./bmc list -snapshots tst_QWidget updateOpaque 10x10x1 walltime \ + linux-g++ barbarella qt master - Example 2 (1250146917 corresponds to the date Thu Aug 13 09:01:57 2009 +0200): +---------------------------------- +Use case 8: List available benchmarks (subject to optional restrictions): - ./bmc compare -history tst_QWidget updateOpaque 10x10x1 walltime \ - linux-g++ barbarella qt master -timestamp 1250146917 + ./bmc list -benchmarks [-metric <metric>] [-platform <platform>] [-host <host>] \ + [-branch <branch>] - Example 3: + Example 1: - ./bmc compare -history tst_QWidget updateOpaque 10x10x1 walltime \ - linux-g++ barbarella qt master -sha1 3bad2f608813968d85c2ea51c1bd75dca7f7e22a + ./bmc list -benchmarks ----------------------------------- -Use case 8: Compare the results of two branches: + Example 2: - ./bmc compare -branches BMCONTEXT <branch1> SNAPSHOT1 <branch2> SNAPSHOT2 + ./bmc list -benchmarks -platform linux-g++ - Example: + Example 3: - ./bmc compare -branches tst_QWidget updateOpaque 10x10x1 walltime \ - linux-g++ barbarella qt 45 -timestamp last qt 46 -timestamp last + ./bmc list -benchmarks -platform linux-g++ -host barbarella -metric walltime \ + -branch qt master ---------------------------------- -Use case 9: Compare a result of a given branch directly to an unregistered - result (i.e. one not yet in the database): +Use case 9: List available metrics (subject to optional restrictions): - ./bmc compare -direct BMCONTEXT <branch> SNAPSHOT (<value> <iterations>) | <xml file> - - Note: If an xml file is specified, it is assumed to contain a - value/iterations pair that matches the benchmark and metric in the - BMCONTEXT. + ./bmc list -metrics [-benchmark <test case> <test function> <data tag>] \ + [-platform <platform>] [-host <host>] [-branch <branch>] Example 1: - ./bmc compare -direct tst_QWidget updateOpaque 10x10x1 walltime \ - linux-g++ barbarella qt master -timestamp last 40 1024 + ./bmc list -metrics Example 2: - ./bmc compare -direct tst_QWidget updateOpaque 10x10x1 walltime \ - linux-g++ barbarella qt master -timestamp last results.xml + ./bmc list -metrics -benchmark tst_QWidget updateOpaque 10x10x1 \ + -platform linux-g++ -host barbarella -branch qt master ---------------------------------- -Use case 10: List available snapshots for a given branch: +Use case 10: List available platforms (subject to optional restrictions): - ./bmc list -snapshots BMCONTEXT <branch> + ./bmc list -platforms [-benchmark <test case> <test function> <data tag>] \ + [-metric <metric>] [-host <host>] [-branch <branch>] - Example: +---------------------------------- +Use case 11: List available hosts (subject to optional restrictions): - ./bmc list -snapshots tst_QWidget updateOpaque 10x10x1 walltime \ - linux-g++ barbarella qt master + ./bmc list -hosts [-benchmark <test case> <test function> <data tag>] \ + [-metric <metric>] [-platform <platform>] [-branch <branch>] ---------------------------------- -Use case 11: List available benchmarks (subject to optional restrictions): +Use case 12: List available branches (subject to optional restrictions): - ./bmc list -benchmarks [-metric <metric>] [-platform <platform>] [-host <host>] \ - [-branch <branch>] + ./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: + + ./bmc compare -history BMCONTEXT <branch> SNAPSHOT Example 1: - ./bmc list -benchmarks + ./bmc compare -history tst_QWidget updateOpaque 10x10x1 walltime \ + linux-g++ barbarella qt master -timestamp first - Example 2: + Example 2 (1250146917 corresponds to the date Thu Aug 13 09:01:57 2009 +0200): - ./bmc list -benchmarks -platform linux-g++ + ./bmc compare -history tst_QWidget updateOpaque 10x10x1 walltime \ + linux-g++ barbarella qt master -timestamp 1250146917 Example 3: - ./bmc list -benchmarks -platform linux-g++ -host barbarella -metric walltime \ - -branch qt master + ./bmc compare -history tst_QWidget updateOpaque 10x10x1 walltime \ + linux-g++ barbarella qt master -sha1 3bad2f608813968d85c2ea51c1bd75dca7f7e22a ---------------------------------- -Use case 12: List available metrics (subject to optional restrictions): - - ./bmc list -metrics [-benchmark <benchmark>] [-platform <platform>] [-host <host>] \ - [-branch <branch>] - - Example 1: +Use case 14: Compare the results of two branches: - ./bmc list -metrics + ./bmc compare -branches BMCONTEXT <branch1> SNAPSHOT1 <branch2> SNAPSHOT2 - Example 2: + Example: - ./bmc list -metrics -benchmark tst_QWidget updateOpaque 10x10x1 \ - -platform linux-g++ -host barbarella -branch qt master + ./bmc compare -branches tst_QWidget updateOpaque 10x10x1 walltime \ + linux-g++ barbarella qt 45 -timestamp last qt 46 -timestamp last ---------------------------------- -Use case 13: List available platforms (subject to optional restrictions): +Use case 15: Compare a result of a given branch directly to an unregistered + result (i.e. one not yet in the database): - ./bmc list -platforms [-benchmark <benchmark>] [-metric <metric>] [-host <host>] \ - [-branch <branch>] + ./bmc compare -direct BMCONTEXT <branch> SNAPSHOT (<value> <iterations>) | <xml file> ----------------------------------- -Use case 14: List available hosts (subject to optional restrictions): + Note: If an xml file is specified (i.e. there's just one instead of two arguments after + the SNAPSHOT argument), it is assumed to contain a value/iterations pair that + matches the benchmark and metric in the BMCONTEXT. - ./bmc list -hosts [-benchmark <benchmark>] [-metric <metric>] [-platform <platform>] \ - [-branch <branch>] + Example 1: ----------------------------------- -Use case 15: List available branches (subject to optional restrictions): + ./bmc compare -direct tst_QWidget updateOpaque 10x10x1 walltime \ + linux-g++ barbarella qt master -timestamp last 40 1024 + + Example 2: - ./bmc list -platforms [-benchmark <benchmark>] [-metric <metric>] [-platform <platform>] \ - [-host <host>] + ./bmc compare -direct tst_QWidget updateOpaque 10x10x1 walltime \ + linux-g++ barbarella qt master -timestamp last results.xml |