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

modules: Update docs with 'setup' stage for module initialization

Browse Source 
Update documentation to include the 'setup' stage for module
initialization.
This commit is contained in:
Marc Bonnici 2018-10-10 10:25:17 +01:00 committed by setrofim
parent 8654a6dc2b
commit fa41bb01d2
2 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
devlib/module/__init__.py
View File

@ -37,6 +37,9 @@ class Module(object):
# serial). # serial).
# 'connected' -- installed when a connection to to the target has been # 'connected' -- installed when a connection to to the target has been
# established. This is the default. # established. This is the default.
# 'setup' -- installed after initial setup of the device has been performed.
# This allows the module to utilize assets deployed during the
# setup stage for example 'Busybox'.
stage = 'connected' stage = 'connected'
@staticmethod @staticmethod

3
doc/modules.rst
View File

@ -212,6 +212,9 @@ define the following class attributes:
:early: The module will be installed when a :class:`Target` is first :early: The module will be installed when a :class:`Target` is first
created. This should be used for modules that do not rely on a created. This should be used for modules that do not rely on a
live connection to the target. live connection to the target.
:setup: The module will be installed after initial setup of the device
has been performed. This allows the module to utilize assets
deployed during the setup stage for example 'Busybox'.
Additionally, a module must implement a static (or class) method :func:`probe`: Additionally, a module must implement a static (or class) method :func:`probe`: