From 704324ca774d49bab525a701fda497ed09f89952 Mon Sep 17 00:00:00 2001 From: Sergei Trofimov Date: Wed, 22 Apr 2015 17:02:27 +0100 Subject: [PATCH] Adding missing descriptions for modules. --- wlauto/modules/active_cooling.py | 9 +++++++++ wlauto/modules/flashing.py | 15 +++++++++++++++ wlauto/modules/reset.py | 3 +++ 3 files changed, 27 insertions(+) diff --git a/wlauto/modules/active_cooling.py b/wlauto/modules/active_cooling.py index 7f9fbb03..580c628e 100644 --- a/wlauto/modules/active_cooling.py +++ b/wlauto/modules/active_cooling.py @@ -21,6 +21,7 @@ from wlauto.utils.serial_port import open_serial_connection class MbedFanActiveCooling(Module): name = 'mbed-fan' + description = 'Controls a cooling fan via an mbed connected to a serial port.' capabilities = ['active_cooling'] @@ -52,6 +53,14 @@ class MbedFanActiveCooling(Module): class OdroidXU3ctiveCooling(Module): name = 'odroidxu3-fan' + description = """ + Enabled active cooling by controling the fan an Odroid XU3 + + .. note:: depending on the kernel used, it may not be possible to turn the fan + off completely; in such situations, the fan will be set to its minimum + speed. + + """ capabilities = ['active_cooling'] diff --git a/wlauto/modules/flashing.py b/wlauto/modules/flashing.py index 4d0a3687..45332dd6 100644 --- a/wlauto/modules/flashing.py +++ b/wlauto/modules/flashing.py @@ -59,6 +59,7 @@ class FastbootFlasher(Flasher): name = 'fastboot' description = """ Enables automated flashing of images using the fastboot utility. + To use this flasher, a set of image files to be flused are required. In addition a mapping between partitions and image file is required. There are two ways to specify those requirements: @@ -138,6 +139,20 @@ class FastbootFlasher(Flasher): class VersatileExpressFlasher(Flasher): name = 'vexpress' + description = """ + Enables flashing of kernels and firmware to ARM Versatile Express devices. + + This modules enables flashing of image bundles or individual images to ARM + Versatile Express-based devices (e.g. JUNO) via host-mounted MicroSD on the + board. + + The bundle, if specified, must reflect the directory structure of the MicroSD + and will be extracted directly into the location it is mounted on the host. The + images, if specified, must be a dict mapping the absolute path of the image on + the host to the destination path within the board's MicroSD; the destination path + may be either absolute, or relative to the MicroSD mount location. + + """ def flash(self, image_bundle=None, images=None): device = self.owner diff --git a/wlauto/modules/reset.py b/wlauto/modules/reset.py index 31003f33..44791415 100644 --- a/wlauto/modules/reset.py +++ b/wlauto/modules/reset.py @@ -24,6 +24,9 @@ class NetioSwitchReset(Module): #pylint: disable=E1101 name = 'netio_switch' + description = """ + Enables hard reset of devices connected to a Netio ethernet power switch + """ capabilities = ['reset_power'] parameters = [