From 1f4bae92bf9ab05675481c1be9a7be7c02656cd8 Mon Sep 17 00:00:00 2001 From: Marc Bonnici Date: Mon, 4 Nov 2019 16:35:03 +0000 Subject: [PATCH] docs/device_setup: Explicitly mention `load_default_modules` This is becoming a commonly used parameter in the `device_config` so explicitly list its functionality. --- .../user_information/how_tos/device_setup.rst | 14 ++++++++++---- .../user_information/user_reference/agenda.rst | 4 +++- 2 files changed, 13 insertions(+), 5 deletions(-) diff --git a/doc/source/user_information/how_tos/device_setup.rst b/doc/source/user_information/how_tos/device_setup.rst index d41cd15f..06d9fbe9 100644 --- a/doc/source/user_information/how_tos/device_setup.rst +++ b/doc/source/user_information/how_tos/device_setup.rst @@ -17,6 +17,8 @@ further configuration will be required. Android ------- +.. _android-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 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 - implements functionality for particular subsystems as modules. A number of - "default" modules (e.g. for cpufreq subsystem) are loaded automatically, - unless explicitly disabled. If additional modules need to be loaded, they - may be specified using this parameter. + implements functionality for particular subsystems as modules. If additional + modules need to be loaded, they may be specified using this parameter. Please see the `devlib documentation `_ for information on the available modules. @@ -83,6 +88,7 @@ or a more specific config could be: device_config: device: 0123456789ABCDEF working_direcory: '/sdcard/wa-working' + load_default_modules: True modules: ['hotplug', 'cpufreq'] core_names : ['a7', 'a7', 'a7', 'a15', 'a15'] # ... diff --git a/doc/source/user_information/user_reference/agenda.rst b/doc/source/user_information/user_reference/agenda.rst index 83d94a49..dbe2a707 100644 --- a/doc/source/user_information/user_reference/agenda.rst +++ b/doc/source/user_information/user_reference/agenda.rst @@ -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 ``device`` to specific an ADB name) as well as configure other 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 `) :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. :max_retries: The maximum number of times failed jobs will be retried before giving up.