From: Andrea Cervesato <andrea.cervesato@suse.de>
To: Linux Test Project <ltp@lists.linux.it>
Subject: [LTP] [PATCH 0/9] doc: Improve and fix documentation and API comments
Date: Thu, 10 Sep 2026 10:33:40 +0200 [thread overview]
Message-ID: <20260910-fix_documentation-v1-0-44313069bbe8@suse.com> (raw)
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.
Signed-off-by: Andrea Cervesato <andrea.cervesato@suse.com>
---
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 | 30 +++++-
doc/developers/api_shell_tests.rst | 5 +-
doc/developers/build_system.rst | 2 +-
doc/developers/test_case_tutorial.rst | 25 +++--
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 | 63 ++++++++++++
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, 424 insertions(+), 222 deletions(-)
---
base-commit: 352f9134942933efcfa608b87ae814db603b3228
change-id: 20260909-fix_documentation-104adc46e555
Best regards,
--
Andrea Cervesato <andrea.cervesato@suse.com>
--
Mailing list info: https://lists.linux.it/listinfo/ltp
next reply other threads:[~2026-09-10 8:34 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-09-10 8:33 Andrea Cervesato [this message]
2026-09-10 8:33 ` [LTP] [PATCH 1/9] doc: Fix examples and generated links Andrea Cervesato
2026-09-10 10:47 ` [LTP] " linuxtestproject.agent
2026-09-10 19:07 ` [LTP] [PATCH 1/9] " Petr Vorel
2026-09-10 8:33 ` [LTP] [PATCH 2/9] doc: Correct guide and API descriptions Andrea Cervesato
2026-09-10 19:32 ` Petr Vorel
2026-09-10 8:33 ` [LTP] [PATCH 3/9] doc: Clarify API coverage and navigation Andrea Cervesato
2026-09-10 19:52 ` Petr Vorel
2026-09-11 6:57 ` Andrea Cervesato via ltp
2026-09-10 8:33 ` [LTP] [PATCH 4/9] include: Document assertion API macros Andrea Cervesato
2026-09-10 8:33 ` [LTP] [PATCH 5/9] include: Document filesystem test utilities Andrea Cervesato
2026-09-10 8:33 ` [LTP] [PATCH 6/9] include: Document memory " Andrea Cervesato
2026-09-10 8:33 ` [LTP] [PATCH 7/9] include: Document safe file operations Andrea Cervesato
2026-09-10 8:33 ` [LTP] [PATCH 8/9] doc: Document CPU and common test helpers Andrea Cervesato
2026-09-10 8:33 ` [LTP] [PATCH 9/9] include: Fix API comment spelling and style Andrea Cervesato
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20260910-fix_documentation-v1-0-44313069bbe8@suse.com \
--to=andrea.cervesato@suse.de \
--cc=ltp@lists.linux.it \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).