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

docs/device_setup: Explicitly mention load_default_modules

Browse Source 
This is becoming a commonly used parameter in the `device_config` so
explicitly list its functionality.
This commit is contained in:
Marc Bonnici 2019-11-04 16:35:03 +00:00 committed by setrofim
parent dcbc00addd
commit 1f4bae92bf
2 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/source/user_information/how_tos/device_setup.rst
View File

@ -17,6 +17,8 @@ further configuration will be required.
Android Android
------- -------
.. _android-general-device-setup:
General Device Setup General Device Setup
^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^
@ -44,12 +46,15 @@ common parameters you might want to change are outlined below.
Android builds. If this is not the case for your device, you will need to Android builds. If this is not the case for your device, you will need to
specify an alternative working directory (e.g. under ``/data/local``). specify an alternative working directory (e.g. under ``/data/local``).
:load_default_modules: A number of "default" modules (e.g. for cpufreq
subsystem) are loaded automatically, unless explicitly disabled. If you
encounter an issue with one of the modules then this setting can be set to
``False`` and any specific modules that you require can be request via the
``modules`` entry.
:modules: A list of additional modules to be installed for the target. Devlib :modules: A list of additional modules to be installed for the target. Devlib
implements functionality for particular subsystems as modules. A number of implements functionality for particular subsystems as modules. If additional
"default" modules (e.g. for cpufreq subsystem) are loaded automatically, modules need to be loaded, they may be specified using this parameter.
unless explicitly disabled. If additional modules need to be loaded, they
may be specified using this parameter.
Please see the `devlib documentation <http://devlib.readthedocs.io/en/latest/modules.html>`_ Please see the `devlib documentation <http://devlib.readthedocs.io/en/latest/modules.html>`_
for information on the available modules. for information on the available modules.
@ -83,6 +88,7 @@ or a more specific config could be:
device_config: device_config:
device: 0123456789ABCDEF device: 0123456789ABCDEF
working_direcory: '/sdcard/wa-working' working_direcory: '/sdcard/wa-working'
load_default_modules: True
modules: ['hotplug', 'cpufreq'] modules: ['hotplug', 'cpufreq']
core_names : ['a7', 'a7', 'a7', 'a15', 'a15'] core_names : ['a7', 'a7', 'a7', 'a15', 'a15']
# ... # ...

4
doc/source/user_information/user_reference/agenda.rst
View File

@ -116,7 +116,9 @@ whole will behave. The most common options that that you may want to specify are
to connect to (e.g. ``host`` for an SSH connection or to connect to (e.g. ``host`` for an SSH connection or
``device`` to specific an ADB name) as well as configure other ``device`` to specific an ADB name) as well as configure other
options for the device for example the ``working_directory`` options for the device for example the ``working_directory``
or the list of ``modules`` to be loaded onto the device. or the list of ``modules`` to be loaded onto the device. (For
more information please see
:ref:`here <android-general-device-setup>`)
:execution_order: Defines the order in which the agenda spec will be executed. :execution_order: Defines the order in which the agenda spec will be executed.
:reboot_policy: Defines when during execution of a run a Device will be rebooted. :reboot_policy: Defines when during execution of a run a Device will be rebooted.
:max_retries: The maximum number of times failed jobs will be retried before giving up. :max_retries: The maximum number of times failed jobs will be retried before giving up.