From: Taseer Date: Fri, 24 Mar 2017 06:09:13 +0000 (+0500) Subject: Update CLI docs. X-Git-Tag: opnfv-5.0.0~250^2 X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=commitdiff_plain;h=af651dce321c7691737ac6df9b256c7fe003aec9;p=qtip.git Update CLI docs. - Update command to execute runner - Include reporter JIRA: QTIP-231 Change-Id: I834ac94821cea7221078fbb6160ef7467b2bd4cf Signed-off-by: Taseer Ahmed --- diff --git a/docs/testing/user/userguide/cli.rst b/docs/testing/user/userguide/cli.rst index e18a36f9..19420bd1 100644 --- a/docs/testing/user/userguide/cli.rst +++ b/docs/testing/user/userguide/cli.rst @@ -12,13 +12,13 @@ along with a short description. qtip [-h|--help] -Typically a complete plan is executed at the -target environment. QTIP defaults to a number of sample plans. One may be able to list them using +Typically a complete plan is executed at the target environment. QTIP defaults to a number of sample plans. +A list of all the available plans can be viewed :: qtip plan list -One can also be able to view the details about a specific plan. +In order to view the details about a specific plan. :: qtip plan show @@ -28,10 +28,23 @@ where *plan_name* is one of those listed from the previous command. To execute a complete plan :: - qtip plan run + qtip plan run -p + +QTIP does not limit result storage at a specific directory. Instead a user may specify his own result storage +as above. An important thing to remember is to provide absolute path of result directory. +:: + + mkdir result + qtip plan run -p $PWD/result Similarly, the same commands can be used for the other two components making up the plans, i.e QPI's and metrics. +QTIP also provides the utility to view benchmarking results on the console. One just need to provide to where +the results are stored. Extending the example above +:: + + qtip report show -p $PWD/result + Debug option helps identify the error by providing a detailed traceback. It can be enabled as ::