Re: [LTP] tst_test.h: Convert rest of doc to kerneldoc

[linuxtestproject.agent@gmail.com]

Hi Petr,

On Tue, 21 Apr 2026 16:41:26 +0200, Petr Vorel wrote:
> tst_test.h: Convert rest of doc to kerneldoc

The commit message body is missing. Please add at least one sentence
explaining why this conversion is being done (e.g. to enable Sphinx
kerneldoc extraction).

> +/**
> + * tst_set_timeout() - Sets the timeout part of the overall timeout.
> + *
[...]
> + * @timeout: A timeout in seconds, defines the total time allowed for a single
> + * test iteration, including the setup, runtime, and teardown phases.

The @timeout description is inaccurate. The implementation computes:

  overall_time = tst_multiply_timeout(DEFAULT_TIMEOUT + timeout) + context->runtime

So @timeout is not the total time per iteration — it is added to
DEFAULT_TIMEOUT before multiplication, and the runtime portion is added
separately. The description should reflect what the argument actually
controls, not the resulting overall_time.

---
Note:

Our agent completed the review of the patch.

The agent can sometimes produce false positives although often its
findings are genuine. If you find issues with the review, please
comment this email or ignore the suggestions.

Regards,
LTP AI Reviewer

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