Re: [PATCH for-10.2 2/8] tests/qtest/libqtest.h: Remove stray space from doc comment

[Mauro Carvalho Chehab <mchehab+huawei@kernel.org>]

Em Thu, 14 Aug 2025 18:13:17 +0100
Peter Maydell <peter.maydell@linaro.org> escreveu:

> The doc comment for qtest_cb_for_every_machine has a stray
> space at the start of its description, which makes kernel-doc
> think that this line is part of the documentation of the
> skip_old_versioned argument. The result is that the HTML
> doesn't have a "Description" section and the text is instead
> put in the wrong place.
> 
> Remove the stray space.
> 
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>

LGTM. Even the previous version should have handled it wrong here
(if not, it is a bug there - or perhaps QEMU version was using
a very old kernel-doc.pl  version).

Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>


> ---
>  tests/qtest/libqtest.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/tests/qtest/libqtest.h b/tests/qtest/libqtest.h
> index b3f2e7fbefd..fd27521a9c7 100644
> --- a/tests/qtest/libqtest.h
> +++ b/tests/qtest/libqtest.h
> @@ -977,7 +977,7 @@ void qtest_qmp_fds_assert_success(QTestState *qts, int *fds, size_t nfds,
>   * @cb: Pointer to the callback function
>   * @skip_old_versioned: true if versioned old machine types should be skipped
>   *
> - *  Call a callback function for every name of all available machines.
> + * Call a callback function for every name of all available machines.
>   */
>  void qtest_cb_for_every_machine(void (*cb)(const char *machine),
>                                  bool skip_old_versioned);



Thanks,
Mauro