macros: Add basic docs
PATCH v2 1/1 macros: Add basic docs
From: Petr Vorel <[email protected]>
Describe all "public" macros.
Move variables to the top.
Add header to the sphinx doc.
---
I've took the changes from Peter and:
- added more verbose description that would hopefully explain the macros better
- added documentation for a few macros that was missing previously
- moved the macros into its own menu category since the Core LTP API is long enough already
doc/developers/api_c_tests.rst | 4 + include/tst_test_macros.h | 403 ++++++++++++++++++++++++++++++++- 2 files changed, 400 insertions(+), 7 deletions(-)
doc/developers/api_c_tests.rst +4 -0
@@ -12,6 +12,10 @@ Core LTP API .. kernel-doc:: ../../include/tst_res_flags.h .. kernel-doc:: ../../include/tst_test.h +Test macros +----------- +.. kernel-doc:: ../../include/tst_test_macros.h + Capabilities ------------ .. kernel-doc:: ../../include/tst_capability.h
include/tst_test_macros.h +396 -7
579 lines not on this page · raw message
Signature · 5 lines
2.49.0 -- Mailing list info: https://lists.linux.it/listinfo/ltp
Hi Cyril,
Quoted 9 lines
Describe all "public" macros.
Move variables to the top.
Add header to the sphinx doc.Signed-off-by Petr Vorel <[email protected]>Signed-off-by Cyril Hrubis <[email protected]>---
I've took the changes from Peter and:
Quoted 7 lines
- added more verbose description that would hopefully explain the macros better
- added documentation for a few macros that was missing previously
- moved the macros into its own menu category since the Core LTP API is long enough already
Thanks a lot for greatly improving and finishing the work. This will help not only to the newcomers to understand the test code.
Kind regards,
Petr
Signature · 1 line
Mailing list info: https://lists.linux.it/listinfo/ltp