Re: [PATCH 03/17] media: media-entity.h: Fix kerneldoc

From: Randy Dunlap
Date: Sat Jan 27 2024 - 15:51:00 EST




On 1/27/24 10:40, Sakari Ailus wrote:
> Hi Randy,
>
> On Fri, Jan 26, 2024 at 05:51:06PM -0800, Randy Dunlap wrote:
>>
>>
>> On 1/26/24 15:16, Ricardo Ribalda wrote:
>>> The fields seems to be documented twice.
>>>
>>> Signed-off-by: Ricardo Ribalda <ribalda@xxxxxxxxxxxx>
>>> ---
>>> include/media/media-entity.h | 4 ----
>>> 1 file changed, 4 deletions(-)
>>>
>>> diff --git a/include/media/media-entity.h b/include/media/media-entity.h
>>> index 2b6cd343ee9e..c79176ed6299 100644
>>> --- a/include/media/media-entity.h
>>> +++ b/include/media/media-entity.h
>>> @@ -337,10 +337,6 @@ enum media_entity_type {
>>> * @info.dev: Contains device major and minor info.
>>> * @info.dev.major: device node major, if the device is a devnode.
>>> * @info.dev.minor: device node minor, if the device is a devnode.
>>> - * @major: Devnode major number (zero if not applicable). Kept just
>>> - * for backward compatibility.
>>> - * @minor: Devnode minor number (zero if not applicable). Kept just
>>> - * for backward compatibility.
>>> *
>>> * .. note::
>>> *
>>>
>>
>> I'd say that this is correct based on
>> https://patchwork.kernel.org/project/linux-media/patch/20231223050707.14091-1-rdunlap@xxxxxxxxxxxxx/
>>

Ah, I see. Thank you.

>>
>> Hans, can you please explain this message from you, on 2024-Jan-22, that
>> I cannot find in the media patchwork:
>
> It's in linuxtv.org Patchwork here
> <URL:https://patchwork.linuxtv.org/project/linux-media/patch/20231223050707.14091-1-rdunlap@xxxxxxxxxxxxx/>
> and also in the media stage tree (as indicated by the state) but not yet in
> master AFAIU.
>
>>
>>
>> Subject: [git:media_stage/master] media: media-entity.h: fix Excess kernel-doc description warnings
>>
>>
>>
>> This is an automatic generated email to let you know that the following patch were queued:
>>
>> Subject: media: media-entity.h: fix Excess kernel-doc description warnings
>> Author: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
>> Date: Fri Dec 22 21:07:07 2023 -0800
>>
>> Remove the @major: and @minor: lines to prevent the kernel-doc warnings:
>>
>> include/media/media-entity.h:376: warning: Excess struct member 'major' description in 'media_entity'
>> include/media/media-entity.h:376: warning: Excess struct member 'minor' description in 'media_entity'
>>
>> Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
>> Reviewed-by: Laurent Pinchart <laurent.pinchart@xxxxxxxxxxxxxxxx>
>> Signed-off-by: Sakari Ailus <sakari.ailus@xxxxxxxxxxxxxxx>
>> Signed-off-by: Hans Verkuil <hverkuil-cisco@xxxxxxxxx>
>>
>> include/media/media-entity.h | 4 ----
>> 1 file changed, 4 deletions(-)
>>
>> ---
>>
>> diff --git a/include/media/media-entity.h b/include/media/media-entity.h
>> index 2b6cd343ee9e..c79176ed6299 100644
>> --- a/include/media/media-entity.h
>> +++ b/include/media/media-entity.h
>> @@ -337,10 +337,6 @@ enum media_entity_type {
>> * @info.dev: Contains device major and minor info.
>> * @info.dev.major: device node major, if the device is a devnode.
>> * @info.dev.minor: device node minor, if the device is a devnode.
>> - * @major: Devnode major number (zero if not applicable). Kept just
>> - * for backward compatibility.
>> - * @minor: Devnode minor number (zero if not applicable). Kept just
>> - * for backward compatibility.
>> *
>> * .. note::
>> *
>>
>>
>>
>> Thanks.
>

--
#Randy