Skip to content

Commit

Permalink
doc/api_c_tests: Add more headers
Browse files Browse the repository at this point in the history
Also sort most of the items alphabetically, add LTP libraries section.

Signed-off-by: Petr Vorel <[email protected]>
  • Loading branch information
pevik committed Dec 13, 2024
1 parent 974bf20 commit f491b34
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 18 deletions.
39 changes: 22 additions & 17 deletions doc/developers/api_c_tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,35 +9,40 @@ LTP C API

Core LTP API
------------

.. kernel-doc:: ../../include/tst_res_flags.h
.. kernel-doc:: ../../include/tst_test.h
.. kernel-doc:: ../../include/tst_kernel.h

Option parsing
--------------

.. kernel-doc:: ../../include/tst_parse.h

Guarded buffers
---------------

.. kernel-doc:: ../../include/tst_buffers.h
Capabilities
------------
.. kernel-doc:: ../../include/tst_capability.h

Checkpoints
-----------

.. kernel-doc:: ../../include/tst_checkpoint.h

Capabilities
------------
Crypto
------
.. kernel-doc:: ../../include/tst_crypto.h
.. kernel-doc:: ../../include/tst_af_alg.h

.. kernel-doc:: ../../include/tst_capability.h
Guarded buffers
---------------
.. kernel-doc:: ../../include/tst_buffers.h

libltpswap
----------
.. kernel-doc:: ../../include/libswap.h
Kernel
------
.. kernel-doc:: ../../include/tst_kernel.h

Option parsing
--------------

.. kernel-doc:: ../../include/tst_parse.h

Temporary directory
-------------------
.. kernel-doc:: ../../include/tst_tmpdir.h

LTP libraries
-------------
.. kernel-doc:: ../../include/libswap.h
4 changes: 3 additions & 1 deletion include/libswap.h
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
* Author: Stanislav Kholmanskikh <[email protected]>
*/

/*
/**
* DOC: libltpswap
*
* Contains common content for all swapon/swapoff tests.
*/

Expand Down

0 comments on commit f491b34

Please sign in to comment.