sascha/workload-automation
1
0
Fork 0
mirror of https://github.com/ARM-software/workload-automation.git synced 2025-04-20 09:40:50 +01:00
Code Issues Releases Wiki Activity

doc: user_guide: add a note about show command

Browse Source 
Add a note describing the usage of "wa show"
This commit is contained in:
Sergei Trofimov 2018-05-18 16:15:07 +01:00 committed by Marc Bonnici
parent 887cdcc411
commit 050722ee8f
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/source/user_guide.rst
View File

@ -65,6 +65,7 @@ For more details, please see the :ref:`installation <apk_files>` section.
List Command List Command
============ ============
In order to get started with using WA we first we need to find In order to get started with using WA we first we need to find
out what is available to use. In order to do this we can use the "list" out what is available to use. In order to do this we can use the "list"
command followed by the type of plugin that you wish to see. command followed by the type of plugin that you wish to see.
@ -99,6 +100,18 @@ The same syntax can be used to display ``commands``,
``resource_getters`` and ``targets``. Alternatively please see the ``resource_getters`` and ``targets``. Alternatively please see the
:ref:`Plugin Reference <plugin-reference>` for an online version. :ref:`Plugin Reference <plugin-reference>` for an online version.
Show Command
============
If you want to learn more information about a particular plugin, such as the
parameters it supports, you can use the "show" command::
wa show dhrystone
If you have ``pandoc`` installed on your system, this will display man
page-like description of the plugin, and the parameters it supports. If you do
not have ``pandoc``, you will instead see the same information as raw
restructured text.
Configure Your Device Configure Your Device
===================== =====================