1
0
mirror of https://github.com/ARM-software/workload-automation.git synced 2025-01-31 10:11:17 +00:00

doc: Fix formatting errors

This commit is contained in:
Marc Bonnici 2018-04-27 10:19:54 +01:00 committed by setrofim
parent 0fd095622c
commit 9741014b35
4 changed files with 19 additions and 14 deletions

View File

@ -874,7 +874,7 @@ Below is a simple instrument that measures the execution time of a workload::
.. _adding-an-output-processor: .. _adding-an-output-processor:
Adding an Output processor Adding an Output processor
------------------------- ----------------------------
A output processor is responsible for processing the results. This may A output processor is responsible for processing the results. This may
involve formatting and writing them to a file, uploading them to a database, involve formatting and writing them to a file, uploading them to a database,

View File

@ -35,7 +35,7 @@ install the application onto the device or source the apk and place into
------------ ------------
**Q:** I am trying to set a valid runtime parameters however I still receive the error ``"Unknown runtime parameter"`` **Q:** I am trying to set a valid runtime parameters however I still receive the error ``"Unknown runtime parameter"``
---------------------------------------------------------------------------------------------------------------------- -------------------------------------------------------------------------------------------------------------------------
**A:** PLease ensure you have the corresponding module loaded on the device. **A:** PLease ensure you have the corresponding module loaded on the device.
Please see :ref:`Runtime Parameters <runtime-parameters>` for the list of Please see :ref:`Runtime Parameters <runtime-parameters>` for the list of
@ -45,7 +45,7 @@ runtime parameters and their containing modules, and the appropriate section in
------------- -------------
**Q:** I have a big.LITTLE device but am unable to set parameters corresponding to the big or little core and receive the error ``"Unknown runtime parameter"`` **Q:** I have a big.LITTLE device but am unable to set parameters corresponding to the big or little core and receive the error ``"Unknown runtime parameter"``
-------------------------------------------------------------------------------------------------------------------------------------------------------------- -----------------------------------------------------------------------------------------------------------------------------------------------------------------
**A:** Please ensure you have the hot plugging module enabled for your device (Please see question above). **A:** Please ensure you have the hot plugging module enabled for your device (Please see question above).

View File

@ -73,10 +73,11 @@ file of a particular size on the device, not all the methods are required to be
implements however as many as possible have been used to demonstrate their implements however as many as possible have been used to demonstrate their
purpose. purpose.
.. note:: This is intended as an example of how to implement the Workload .. note:: This is intended as an example of how to implement the Workload
:ref: `interface <workload-interface>`. The methodology used to :ref:`interface <workload-interface>`. The methodology used to
perform the actual measurement is not necessarily sound, and this perform the actual measurement is not necessarily sound, and this
Workload should not be used to collect real measurements. Workload should not be used to collect real measurements.
.. code-block:: python .. code-block:: python
@ -362,11 +363,12 @@ The main difference between the two is that this workload will subclass
Adding an Instrument Example Adding an Instrument Example
============================= =============================
This is an example of how we would create a instrument which will trace device This is an example of how we would create a instrument which will trace device
errors. For more detailed information please see :ref:`here <instrument-reference>`. errors. For more detailed information please see
The first thing to do is to subclass :class:`Instrument`, overwrite :ref:`here <instrument-reference>`. The first thing to do is to subclass
the variable name with what we want our instrument to be called and locate our :class:`Instrument`, overwrite the variable name with what we want our instrument
binary for our instrument. :: to be called and locate our binary for our instrument.
::
class TraceErrorsInstrument(Instrument): class TraceErrorsInstrument(Instrument):
name = 'trace-errors' name = 'trace-errors'
@ -379,10 +381,10 @@ binary for our instrument. ::
We then declare and implement the required methods as detailed We then declare and implement the required methods as detailed
:ref:`here <instrument-api>`. For the ``initialize`` method, we want to install :ref:`here <instrument-api>`. For the ``initialize`` method, we want to install
the executable file to the target so we can use the target's ``install`` the executable file to the target so we can use the target's ``install``
method which will try to copy the file to a location on the device that method which will try to copy the file to a location on the device that
supports execution, will change the file mode appropriately and return the supports execution, will change the file mode appropriately and return the
file path on the target. :: file path on the target. ::
def initialize(self, context): def initialize(self, context):
self.trace_on_target = self.target.install(self.binary_file) self.trace_on_target = self.target.install(self.binary_file)
@ -524,6 +526,7 @@ the :ref:`context <context>`.
.. _adding-custom-target-example: .. _adding-custom-target-example:
Adding a Custom Target Example Adding a Custom Target Example
=============================== ===============================
This is an example of how we would create a customised target, this is typically This is an example of how we would create a customised target, this is typically

View File

@ -417,6 +417,8 @@ the device you wish to use for that particular test.
.. note:: As previously mentioned, any more specific configuration present in .. note:: As previously mentioned, any more specific configuration present in
the agenda file will overwrite the corresponding config parameters the agenda file will overwrite the corresponding config parameters
specified in the config file(s). specified in the config file(s).
:: ::
wa run -c myconfig.yaml ~/myagenda.yaml wa run -c myconfig.yaml ~/myagenda.yaml