From 0d2b48ea0fafe79b114637893b0dd765bcf87030 Mon Sep 17 00:00:00 2001 From: Yujun Zhang Date: Wed, 26 Jul 2017 13:43:19 +0800 Subject: Add section headers to user guide Change-Id: If037d2424ad350fa422f3d5fc75648bf9bcbec90 Signed-off-by: Yujun Zhang --- docs/testing/user/userguide/cli.rst | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'docs') 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 -p $PWD/result +Debugging options +================= + Debug option helps identify the error by providing a detailed traceback. It can be enabled as :: -- cgit 1.2.3-korg