diff options
author | jasplin <qt-info@nokia.com> | 2009-09-25 12:53:03 +0200 |
---|---|---|
committer | jasplin <qt-info@nokia.com> | 2009-09-25 12:53:03 +0200 |
commit | 9fe19f57d03338ee863acac49f294e3ef2682fc5 (patch) | |
tree | 2bca3a0f942e2f9aa4b16c16e7222b10240e9d28 /doc | |
parent | d06bae5faf0a910404de7bf31f00265883f04536 (diff) |
Implemented file comparison.
#Please enter the commit message for your changes. Lines starting
Diffstat (limited to 'doc')
-rw-r--r-- | doc/bmc.html | 78 |
1 files changed, 72 insertions, 6 deletions
diff --git a/doc/bmc.html b/doc/bmc.html index 7c6d7f5..aeced44 100644 --- a/doc/bmc.html +++ b/doc/bmc.html @@ -26,8 +26,10 @@ The program writes output (if any) to standard output or standard error. If the program is run without any command-line arguments it is run in <i>CGI mode</i>. In this case, the program is assumed to be launched by a web server in response to a request from a web client. Arguments are extracted from the -environment and output is written to standard output in a format suitable for -being sent back to and processed by the web client. +QUERY_STRING environment variable or from the standard input depending on +whether the HTTP request method was GET or POST respectively. The output is +written to standard output in a format suitable for being sent back to and +processed by the web client (typically JSON - see below). <p /> If command-line arguments are present the program is run in <i>raw mode</i>. @@ -62,13 +64,13 @@ In raw mode, the server location may also be specified by passing the The command-line option overrides the environment variable. -<h3>Commands</h3> +<h3>Commands taking arguments</h3> <b>Note:</b> The 'Command' column in the table below shows the raw mode command line -syntax. In CGI mode the initial arguments (passed in environment variables) -are converted internally to a format that is equivalent to the raw mode -command line. +syntax. In CGI mode the initial arguments (passed in the QUERY_STRING +environment variable) are converted internally to a format that is equivalent +to the raw mode command line. <br /><br /> @@ -521,5 +523,69 @@ Content-type: text/json </table> +<br /><br /> + +<h3>Commands without arguments</h3> + +<b>Note:</b> + +The commands below assume their input to be passed on standard input only +(i.e. no command-line arguments and no QUERY_STRING environment +variable). They are used in CGI-mode for requests that need to pass their +input using POST (rather than GET) as the HTTP request method. + +<br /><br /> + +<table border=1> +<tr> + <th>Command</th> + <th>Description</th> + <th>Standard input</th> + <th>Standard output</th> +</tr> + +<!-- ---------------------------------------------------------------------------------- --> +<tr> +<td> +<pre class="command"> +./bmc +</pre> +</td> +<td class="commandDescr"> +Extracts all results. +</td> +<td> +<i>XML structure having the same format as that produced by QTestLib.</i> +</td> + +<td> +<pre> +Content-type: text/json + +{ + "testCase": "<test case>", + "testFunctions": [ + { + "testFunction": "<test function>", + "results": [ + { + "dataTag": "<data tag>", + "metric": "<metric>", + "value": "<value>", + "iterations": "<iterations>" + }, + ... + ] + }, + ... + ] +} +</pre> +</td> + +</tr> + +</table> + </body> </html> |