diff options
| author |   zhihui wu <wu.zhihui1@zte.com.cn> | 2017-07-31 04:12:36 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@opnfv.org> | 2017-07-31 04:12:36 +0000 |
| commit | 8d305ca12561a477293a2f6b7d09f6f968826843 (patch) | |
| tree | 118194ce4ab05d6b86cba93a54844dc134a0d7e8 | |
| parent | e3e6e3287cd6db05bf5471b01838cc52549a7a8c (diff) | |
| parent | 0d2b48ea0fafe79b114637893b0dd765bcf87030 (diff) | |
Merge "Add section headers to user guide"
| -rw-r--r-- | docs/testing/user/userguide/cli.rst | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/testing/user/userguide/cli.rst b/docs/testing/user/userguide/cli.rst index 6e022f01..8a983155 100644 --- a/docs/testing/user/userguide/cli.rst +++ b/docs/testing/user/userguide/cli.rst @@ -19,12 +19,17 @@ Add the following line to the **.bashrc** file eval "$(_QTIP_COMPLETE=source qtip)" +Getting help +============ + QTIP CLI provides interface to all of the above the components. A help page provides a list of all the commands along with a short description. :: qtip [-h|--help] +Usage +===== 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 :: @@ -64,6 +69,9 @@ the results are stored. Extending the example above qtip report show <metric_name> -p $PWD/result +Debugging options +================= + Debug option helps identify the error by providing a detailed traceback. It can be enabled as :: |