Re: [LTP] doc: Add missing API references to api_c_tests.rst

[linuxtestproject.agent@gmail.com]

Hi,

[PATCH 1/3] doc: Add missing API references to api_c_tests.rst

The commit message accurately describes the changes. The Fixes: tag is
correct. The kernel-doc format conversions look good overall, but there
is one bug (see below).

> diff --git a/include/tst_fuzzy_sync.h b/include/tst_fuzzy_sync.h
> ...
> +/**
> + * tst_fzsync_wait_a() - Wait in thread A.
> + * @pair: Fuzzy sync pair.
> + */
>  */
>  static inline void tst_fzsync_wait_a(struct tst_fzsync_pair *pair)

BUG: The patch adds a new closing `*/` at line 617 but does not remove
the pre-existing `*/` at line 618 (the old comment's closing marker).
The result in the file is two consecutive `*/` lines:

  614: /**
  615:  * tst_fzsync_wait_a() - Wait in thread A.
  616:  * @pair: Fuzzy sync pair.
  617:  */
  618:  */            <-- stray; causes a compilation error
  619: static inline void tst_fzsync_wait_a(struct tst_fzsync_pair *pair)

A bare `*/` at file scope is invalid C and will fail to compile.
Please drop line 618.

Verdict: Needs revision ✗

---

[PATCH 2/3] doc: Complete struct tst_test table and shell API docs

The eight new .struct tst_test rows all correspond to real fields in
include/tst_test.h. The mnt_flags / min_swap_avail re-ordering is
correct (alphabetical order is now min_r < min_s < mnt_f). The shell
API variable reference section has been verified against the
implementation in testcases/lib/tst_test.sh:

- TST_CHECKPOINT_WAIT/WAKE/WAKE2/WAKE_AND_WAIT signatures are accurate.
- TST_RETRY_FUNC (2 args) and TST_RETRY_FN_EXP_BACKOFF (3 args) match.
- TST_NEEDS_KCONFIGS_IFS default delimiter (comma) is correct.
- TST_DEVICE_SIZE, TST_SKIP_IN_LOCKDOWN, TST_SKIP_IN_SECUREBOOT,
  TST_TIMEOUT all match the shell library.
- .forks_child / .runs_script as "not applicable" in shell is correct.
- .min_runtime / .needs_abi_bits as \- (no shell equivalent) is correct.

Verdict: Reviewed-by: LTP AI Reviewer <ltp-ai-reviewer@example.com> ✓

---

[PATCH 3/3] doc: Add SAFE_* macros reference page

The new api_safe_macros.rst file lists 245 SAFE_* entries, matching
the count in the commit message. The SAFE_MMAP signature was verified
against tst_safe_macros_inline.h. The toctree placement in doc/index.rst
(after api_c_tests, before api_shell_tests) is logical. The For
Developers section blurb is accurate.

Verdict: Reviewed-by: LTP AI Reviewer <ltp-ai-reviewer@example.com> ✓

---

Series verdict: Needs revision

The only blocking issue is in patch 1/3: the duplicate `*/` on line 618
of include/tst_fuzzy_sync.h, introduced when converting the
tst_fzsync_wait_a() comment to kernel-doc format. This is a compilation
error. Patches 2/3 and 3/3 look good.

LTP AI Reviewer

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