Skip to content

doc: Improve and fix documentation and API comments

Andrea Cervesato ltp 2 versions – Applied

Status from this message: Merged, Thanks!

Get series with b4
b4 am [email protected] change-id 20260909-fix_documentation-104adc46e555

Versions newest first

  1. v2 Latest9 patches 8 repliesApplied
  2. v19 patches 5 repliesSuperseded

Changes in v2 from the cover letter

- point network API documentation directly to testcases/network/README.md
- fix commit hash in the example
- Link to v1: https://lore.kernel.org/[email protected]

Patches in v2 Applied

#Subject and filesSizeRepliesApplied
1/9doc: Fix examples and generated linksdoc/conf.py doc/developers/api_shell_tests.rst doc/users/testers_guide.rst+8 -70 replies
2/9doc: Correct guide and API descriptionsINSTALL doc/developers/build_system.rst doc/developers/test_case_tutorial.rst +4 more+40 -351 reply
3/9doc: Clarify API coverage and navigationdoc/developers/api_network_tests.rst doc/developers/writing_tests.rst doc/index.rst+13 -30 replies
4/9include: Document assertion API macrosinclude/tst_assert.h+56 -291 reply
5/9include: Document filesystem test utilitiesinclude/tst_fs.h+127 -591 reply
6/9include: Document memory test utilitiesinclude/tst_memutils.h+33 -371 reply
7/9include: Document safe file operationsinclude/tst_safe_file_ops.h+59 -00 replies
8/9doc: Document CPU and common test helpersdoc/developers/api_c_tests.rst include/tst_common.h+15 -81 reply
9/9include: Fix API comment spelling and styleinclude/tse_numa.h include/tst_buffers.h include/tst_checkpoint.h +6 more+46 -461 reply

Reviews trailers per patch

All 9 patches have a Reviewed-by or Acked-by.

PatchPetr Vorel
1/9R-b
2/9R-b R-b
3/9R-b
4/9R-b R-b
5/9R-b R-b
6/9R-b R-b
7/9R-b
8/9R-b R-b
9/9R-b R-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v2 thread

Cover letter [LTP] [PATCH v2 0/9] doc: Improve and fix documentation and API comments

This series improves documentation accuracy, adds missing kernel-doc comments for public C test APIs, and fixes errors across Sphinx docs and header comments:

- Fix Sphinx configuration paths and git commit URLs, repair JSON syntax in shell API examples, and replace hardcoded HTML anchors with Sphinx references.
- Correct tutorial instructions, command flags, and file descriptor cleanup patterns to adhere to LTP conventions.
- Expand documentation navigation by linking the testers guide in the user index and adding an overview for single-host and two-host network test setups.
- Add kernel-doc comments for public macros and helpers in tst_assert.h, tst_fs.h, tst_memutils.h, and tst_safe_file_ops.h.
- Add tst_common.h and tst_cpu.h to the C API reference documentation.
- Normalize kernel-doc Return tags and fix typographical and grammatical errors across header comments.

---
Changes in v2:
- point network API documentation directly to testcases/network/README.md
- fix commit hash in the example
- Link to v1: https://lore.kernel.org/[email protected]

---
Andrea Cervesato (9):
doc: Fix examples and generated links
doc: Correct guide and API descriptions
doc: Clarify API coverage and navigation
include: Document assertion API macros
include: Document filesystem test utilities
include: Document memory test utilities
include: Document safe file operations
doc: Document CPU and common test helpers
include: Fix API comment spelling and style

 INSTALL                               |  10 +-
 doc/conf.py                           |   4 +-
 doc/developers/api_c_tests.rst        |   5 +
 doc/developers/api_network_tests.rst  |   5 +-
 doc/developers/api_shell_tests.rst    |   7 +-
 doc/developers/build_system.rst       |   2 +-
 doc/developers/test_case_tutorial.rst |  27 ++---
 doc/developers/writing_tests.rst      |   8 ++
 doc/index.rst                         |   3 +
 doc/users/testers_guide.rst           |   4 +-
 include/tse_numa.h                    |  10 +-
 include/tst_assert.h                  |  85 ++++++++++------
 include/tst_buffers.h                 |  10 +-
 include/tst_checkpoint.h              |   6 +-
 include/tst_cmd.h                     |   2 +
 include/tst_common.h                  |  18 ++--
 include/tst_fs.h                      | 186 +++++++++++++++++++++++-----------
 include/tst_memutils.h                |  70 ++++++-------
 include/tst_process_state.h           |   8 +-
 include/tst_safe_file_ops.h           |  59 +++++++++++
 include/tst_test.h                    |  20 ++--
 include/tst_test_macros.h             |  58 +++++------
 include/ujson_common.h                |   2 +-
 include/ujson_reader.h                |   8 +-
 include/ujson_utf.h                   |   2 +-
 include/ujson_writer.h                |   2 +-
 26 files changed, 397 insertions(+), 224 deletions(-)

---
base-commit: 72a170823fb0d03a6a2292934c800c4e522ec40d
change-id: 20260909-fix_documentation-104adc46e555

Best regards,

Signature · 5 lines
Andrea Cervesato <[email protected]>


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp