mirror of
https://github.com/ARM-software/workload-automation.git
synced 2025-03-21 18:18:41 +00:00
doc: Update reference and fix typos
This commit is contained in:
parent
86cc449203
commit
19184ceaf6
@ -312,7 +312,7 @@ that it will be in ``PATH`` on the target (or that the executable with the same
|
||||
name in ``PATH`` is the version deployed by WA.
|
||||
|
||||
For more information on how to implement this, please see the
|
||||
:ref:`how to guide <deploying-executables-guide>`.
|
||||
:ref:`how to guide <deploying-executables-example>`
|
||||
|
||||
|
||||
Deploying assets
|
||||
|
@ -1,7 +1,7 @@
|
||||
.. _deploying-executables-guide:
|
||||
.. _deploying-executables-example:
|
||||
|
||||
Installing Binaries Example
|
||||
===========================
|
||||
Deploying Executables Example
|
||||
==============================
|
||||
|
||||
Installing binaries for a particular plugin should generally only be performed
|
||||
once during a run. This should typically be done in the ``initialize`` method,
|
||||
@ -369,6 +369,7 @@ errors. For more detailed information please see
|
||||
to be called and locate our binary for our instrument.
|
||||
|
||||
::
|
||||
|
||||
class TraceErrorsInstrument(Instrument):
|
||||
|
||||
name = 'trace-errors'
|
||||
@ -410,7 +411,7 @@ again decorated the method::
|
||||
Once we have generated our result data we need to retrieve it from the device
|
||||
for further processing or adding directly to WA's output for that job. For
|
||||
example for trace data we will want to pull it to the device and add it as a
|
||||
:ref:`artifact <atrifact>` to WA's :ref:`context <context>` as shown below::
|
||||
:ref:`artifact <artifact>` to WA's :ref:`context <context>` as shown below::
|
||||
|
||||
def extract_results(self, context):
|
||||
# pull the trace file from the target
|
||||
|
@ -228,10 +228,10 @@ WA has various resource getters that can be configured to locate APK files but
|
||||
for most people APK files should be kept in the
|
||||
``$WA_USER_DIRECTORY/dependencies/SOME_WORKLOAD/`` directory. (by default
|
||||
``~/.workload_automation/dependencies/SOME_WORKLOAD/``). The
|
||||
``WA_USER_DIRECTORY`` enviroment variable can be used to change the location of
|
||||
``WA_USER_DIRECTORY`` environment variable can be used to change the location of
|
||||
this folder. The APK files need to be put into the corresponding directories for
|
||||
the workload they belong to. The name of the file can be anything but as
|
||||
explained below may need to contain certain peices of information.
|
||||
explained below may need to contain certain pieces of information.
|
||||
|
||||
All ApkWorkloads have parameters that affect the way in which APK files are
|
||||
resolved, ``exact_abi``, ``force_install`` and ``prefer_host_package``. Their
|
||||
@ -276,7 +276,7 @@ their APK files are resolved.
|
||||
This parameter is used to specify which version of uiautomation for the
|
||||
workload is used. In some workloads e.g. ``geekbench`` multiple versions with
|
||||
drastically different UI's are supported. A APKs version will be
|
||||
automatically extracted therefore it is possible to have mutiple apks for
|
||||
automatically extracted therefore it is possible to have multiple apks for
|
||||
different versions of a workload present on the host and select between which
|
||||
is used for a particular job by specifying the relevant version in your
|
||||
:ref:`agenda <agenda>`.
|
||||
|
@ -225,9 +225,9 @@ which contains addional information about how to build and to use the file.
|
||||
============================
|
||||
|
||||
Some WA plugins have additional dependencies that need to be
|
||||
statisfied before they can be used. Not all of these can be provided with WA and
|
||||
satisfied before they can be used. Not all of these can be provided with WA and
|
||||
so will need to be supplied by the user. They should be placed into
|
||||
``~/.workload_uatomation/dependencies/<extenion name>`` so that WA can find
|
||||
``~/.workload_uatomation/dependencies/<extension name>`` so that WA can find
|
||||
them (you may need to create the directory if it doesn't already exist). You
|
||||
only need to provide the dependencies for workloads you want to use.
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user