xref: /aosp_15_r20/external/ltp/doc/index.rst (revision 49cdfc7efb34551c7342be41a7384b9c40d7cab7)
1.. SPDX-License-Identifier: GPL-2.0-or-later
2
3.. include:: ../README.rst
4
5.. toctree::
6   :maxdepth: 3
7   :hidden:
8   :caption: For users
9
10   users/quick_start
11   users/setup_tests
12   users/supported_systems
13   users/stats
14
15.. toctree::
16   :maxdepth: 3
17   :hidden:
18   :caption: For developers
19
20   developers/setup_mailinglist
21   developers/writing_tests
22   developers/test_case_tutorial
23   developers/api_c_tests
24   developers/api_shell_tests
25   developers/api_network_tests
26   developers/api_kvm_tests
27   developers/ltp_library
28   developers/build_system
29   developers/debugging
30   developers/documentation
31
32.. toctree::
33   :maxdepth: 3
34   :hidden:
35   :caption: For maintainers
36
37   maintainers/patch_review
38   maintainers/ltp_release_procedure
39
40For users
41---------
42
43.. descriptions here are active
44
45:doc:`users/quick_start`
46   How to build and use LTP framework in few steps
47
48:doc:`users/setup_tests`
49   How to setup tests execution
50
51:doc:`users/supported_systems`
52   A list of supported technologies by the LTP framework
53
54:doc:`users/stats`
55   Some LTP statistics
56
57For developers
58--------------
59
60.. descriptions here are active
61
62:doc:`developers/setup_mailinglist`
63   How to configure git and to start sending patches via :git_man:`send-email`.
64
65:doc:`developers/writing_tests`
66   Starting guide on writing tests
67
68:doc:`developers/test_case_tutorial`
69   A tutorial showing how to write a test from scratch using C API
70
71:doc:`developers/api_c_tests`
72   Walk through the C API features
73
74:doc:`developers/api_shell_tests`
75   Walk through the Shell API features
76
77:doc:`developers/api_network_tests`
78   Walk through the network API features
79
80:doc:`developers/api_kvm_tests`
81   Walk through the KVM API features
82
83:doc:`developers/ltp_library`
84   Developing new features in the LTP library
85
86:doc:`developers/build_system`
87   Short introduction to the LTP build system
88
89:doc:`developers/debugging`
90   How to debug LTP tests
91
92:doc:`developers/documentation`
93   How to use and develop LTP documentation
94
95For maintainers
96---------------
97
98:doc:`maintainers/patch_review`
99   Steps to follow when reviewing patches
100
101:doc:`maintainers/ltp_release_procedure`
102   Steps to follow for a new LTP release
103
104
105Getting help
106------------
107To report a problem or suggest any feature, please write at [email protected]
108