[igt-dev] [PATCH i-g-t v3 4/4] lib/igt_kmod: add igt_kselftests documentation

[André Almeida]

On 8/15/22 14:20, Tales wrote:
> Hello,
> 
> Em seg., 15 de ago. de 2022 às 13:46, André Almeida <tonyk at igalia.com> escreveu:
>>
>> Hi Tales,
>>
>> On 8/15/22 11:51, Tales Aparecida wrote:
>>> Add documentation for igt_kselftests functions and structs. Also adds
>>> comments to non trivial lines.
>>>
>>> Signed-off-by: Tales Aparecida <tales.aparecida at gmail.com>
>>> ---
>>>
>>> Notes:
>>>       v2 -> v3: rephrase igt_kselftest_begin() documentation to say skips instead of fails
>>>
>>>    lib/igt_kmod.c | 109 +++++++++++++++++++++++++++++++++++++++++++++++++
>>>    lib/igt_kmod.h |  18 ++++++++
>>>    2 files changed, 127 insertions(+)
>>>
>>> diff --git a/lib/igt_kmod.c b/lib/igt_kmod.c
>>> index 5864f68c..a39bec18 100644
>>> --- a/lib/igt_kmod.c
>>> +++ b/lib/igt_kmod.c
>>> @@ -792,6 +792,12 @@ igt_amdgpu_driver_unload(void)
>>>        return IGT_EXIT_SUCCESS;
>>>    }
>>>
>>> +/**
>>> + * kmsg_dump:
>>> + * @fd: file descriptor for `/dev/kmsg` opened for reading
>>
>> In other places you refer to this file as
>> <filename>/dev/kmsg</filename>, should it be the same here?
> 
> I might have skipped this one just to avoid line breaking.
> I found that using the <filename> tag provides very similar styling to
> `back tick quoting` when rendering the documentation,
> but can make the raw code less readable.
> 
> I can convert it though!
> 

I see, thanks for the clarification. I think it can be left as this, but 
it's a good practice to be consistent given that people may use this as 
reference for new documentation.

Anyhow, series is Reviewed-by: André Almeida <andrealmeid at igalia.com>

> Thanks for the review, André.
> 
> Kind regards,
> Tales