aboutsummaryrefslogtreecommitdiff
path: root/doc/reference.rst
blob: aa0cbcbac5ead7859fd862e3d31d58faad2886b9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
.. _reference:

=========
Reference
=========

.. _command_reference:

Command Reference
=================

.. automodule:: lava_android_test.commands
    :members:

.. todo::

    * Describe basic commands
    * Describe arguments and options to each command in detail

Pathnames and files
===================

LAVA Android Test uses the following files:

* ``/tmp/lava-android-test/`` -- temporary directory to put temporary files of each lava-android-test instance.

.. _code_reference:

Code reference
==============

.. todo::

    * Describe general code layout
    * Describe key API integration points (on a separate page if needed for clarity)
    * Provide an example test and walk the reader through the meaning of each part

Abstract Interfaces
^^^^^^^^^^^^^^^^^^^

.. automodule:: lava_android_test.api
    :members:

Test definitions and test providers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: lava_android_test.test_definitions
    :members:

Test components (installers, runners and parsers)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: lava_android_test.testdef
    :members:

Core Modules
^^^^^^^^^^^^

.. automodule:: lava_android_test.config
    :members:

Environment Scanners
^^^^^^^^^^^^^^^^^^^^

.. automodule:: lava_android_test.hwprofile
    :members:

.. automodule:: lava_android_test.swprofile
    :members:

Utilities
^^^^^^^^^

.. automodule:: lava_android_test.utils
    :members: