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