sascha/devlib
1
0
Fork 0
mirror of https://github.com/ARM-software/devlib.git synced 2025-10-30 13:33:19 +00:00
Code Issues Releases Wiki Activity

doc: documenting Platforms and Modules

Browse Source 
Adding documentation for Platforms and Modules API.
This commit is contained in:
Sergei Trofimov
2016-12-09 15:06:35 +00:00
parent b3cea0c0d2
commit 1ba7fbdc9a
4 changed files with 308 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/target.rst
View File

@@ -18,7 +18,7 @@ Target
available). If a :class:`Platform` instance is not specified on
:class:`Target` creation, one will be created automatically and it will
dynamically probe the device to discover as much about the underlying
hardware as it can.
hardware as it can. See also :ref:`platform`\ .
:param working_directory: This is primary location for on-target file system
interactions performed by ``devlib``. This location *must* be readable and
@@ -53,7 +53,7 @@ Target
:param modules: a list of additional modules to be installed. Some modules will
try to install by default (if supported by the underlying target).
Current default modules are ``hotplug``, ``cpufreq``, ``cpuidle``,
``cgroups``, and ``hwmon``.
``cgroups``, and ``hwmon`` (See :ref:`modules`\ ).
See modules documentation for more detail.