[LTP] [PATCH 2/2] macros: Add basic docs

[Andrea Cervesato]

Ok thanks,

Reviewed-by: Andrea Cervesato <andrea.cervesato@suse.com>

Kind regards,
Andrea

On 1/10/25 15:57, Petr Vorel wrote:
> Hi Andrea,
>
>> Hi Petr,
>> thanks for this documentation. It's really needed.
> Yes, I had it long time in my mind. Thanks for the review.
> ...
>>> +++ b/include/tst_test_macros.h
>>> @@ -1,7 +1,11 @@
>>>    // SPDX-License-Identifier: GPL-2.0-or-later
>>>    /*
>>>     * Copyright (c) 2015-2024 Cyril Hrubis <chrubis@suse.cz>
>>> - * Copyright (c) Linux Test Project, 2021-2022
>>> + * Copyright (c) Linux Test Project, 2021-2024
>>> + */
>>> +
>>> +/**
>>> + * DOC: tst_test_macros.h -- helpers for testing syscalls
>>>     */
>> Is this really needed?
> Well, IMHO throwing just functions description to users is not enough.
> I would even add a short description about the goal of these macros.
>
> And because sooner or later as we increase sphinx doc in the headers the list
> will be quite long. Therefore for the start I added just a title (short
> paragraph with a description would be of curse  better).
>
> Kind regards,
> Petr