[LTP] [PATCH 00/10] New LTP documentation

Andrea Cervesato andrea.cervesato@suse.de
Wed Mar 20 17:20:44 CET 2024


The new LTP documentation is meant to use Sphinx as the main
documentation framework, with ReconStructedText as the main language.
All the conversion has been done step-by-step, each chapter at time,
updating english syntax and fixing typos. There are minor improvements,
but overall the structure is the same.

C / Networking / KVM API are not documented yet, because they will be
probably integrated in the LTP library. C API documentation is already
on going, but the others not.

For a demo, please take a look at:

https://ltp-acerv.readthedocs.io/en/latest/index.html

Signed-off-by: Andrea Cervesato <andrea.cervesato@suse.com>
---
Andrea Cervesato (10):
      Add the new basics documentation
      Add new mailing list setup documentation
      Rewrite writing tests guidelines documentation
      Refactor patch review guidelines documentation
      Refactor LTP release procedure documentation
      Refactor debugging documentation
      Refactor LTP library guidelines documentation
      Refactor build system documentation
      Refactor test case tutorial documentation
      Introduce kernel-doc API support

 .readthedocs.yml                              |   15 +
 doc_new/.gitignore                            |    1 +
 doc_new/Makefile                              |    5 +
 doc_new/_static/custom.css                    |    4 +
 doc_new/conf.py                               |   26 +
 doc_new/developers/api_c_tests.rst            |    7 +
 doc_new/developers/api_kvm_tests.rst          |    7 +
 doc_new/developers/api_network_tests.rst      |    7 +
 doc_new/developers/api_shell_tests.rst        |    4 +
 doc_new/developers/build_system.rst           |  213 +++++
 doc_new/developers/debugging.rst              |   21 +
 doc_new/developers/ltp_library.rst            |   42 +
 doc_new/developers/setup_mailinglist.rst      |   50 ++
 doc_new/developers/test_case_tutorial.rst     | 1038 +++++++++++++++++++++++++
 doc_new/developers/writing_tests.rst          |  537 +++++++++++++
 doc_new/index.rst                             |  124 +++
 doc_new/maintainers/ltp_release_procedure.rst |  173 +++++
 doc_new/maintainers/patch_review.rst          |  171 ++++
 doc_new/requirements.txt                      |    2 +
 doc_new/users/quick_start.rst                 |  126 +++
 doc_new/users/setup_tests.rst                 |  104 +++
 doc_new/users/supported_systems.rst           |  110 +++
 22 files changed, 2787 insertions(+)
---
base-commit: 6c37214b32d6632bec79f864d2435149b1768f3b
change-id: 20240314-new_website-3b7505c742e4

Best regards,
-- 
Andrea Cervesato <andrea.cervesato@suse.com>



More information about the ltp mailing list