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

doc: Restructure developer information

Browse Source 
Re-organise and add additional information to developer guide.
This commit is contained in:
Marc Bonnici
2018-06-25 09:30:14 +01:00
committed by setrofim
parent a64bb3a26f
commit 2f94d12b57
9 changed files with 455 additions and 538 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/developer_information/how_tos/adding_plugins.rst
View File

@@ -7,7 +7,7 @@ Installing binaries for a particular plugin should generally only be performed
once during a run. This should typically be done in the ``initialize`` method,
if the only functionality performed in the method is to install the required binaries
then the ``initialize`` method should be decorated with the ``@once``
:ref:`decorator <decorators>` otherwise this should be placed into a dedicated
:ref:`decorator <execution-decorators>` otherwise this should be placed into a dedicated
method which is decorated instead. Please note if doing this then any installed
paths should be added as class attributes rather than instance variables. As a
general rule if binaries are installed as part of ``initialize`` then they
@@ -75,7 +75,7 @@ to compress a file of a particular size on the device.
.. note:: This is intended as an example of how to implement the Workload
:ref:`interface <workload-interface>`. The methodology used to
:ref:`interface <workload-api>`. The methodology used to
perform the actual measurement is not necessarily sound, and this
Workload should not be used to collect real measurements.