Re: [PATCH] device property: add missing kernel-doc for property_entry
Andy Shevchenko <[email protected]>
| Newsgroups | dev.linux.lists.driver-core,org.kernel.vger.linux-acpi,org.kernel.vger.linux-kernel |
|---|---|
| Organization | Intel Finland Oy - BIC 0357606-4 - c/o Alberga Business Park, 6 krs, Bertel Jungin Aukio 5, 02600 Espoo |
| Message-ID | <[email protected]> |
On Mon, Jul 20, 2026 at 08:30:59AM -0700, Randy Dunlap wrote: > On 7/20/26 4:51 AM, Andy Shevchenko wrote: > > On Sun, Jul 19, 2026 at 03:36:40PM -0700, Randy Dunlap wrote: > >> Add kernel-doc for the missing fields in union value: > >> > >> Warning: include/linux/property.h:406 struct member 'u8_data' not > >> described in 'property_entry' > >> Warning: include/linux/property.h:406 struct member 'u16_data' not > >> described in 'property_entry' > >> Warning: include/linux/property.h:406 struct member 'u32_data' not > >> described in 'property_entry' > >> Warning: include/linux/property.h:406 struct member 'u64_data' not > >> described in 'property_entry' > >> Warning: include/linux/property.h:406 struct member 'str' not described > >> in 'property_entry' ... > >> * @pointer: Pointer to the property when it is not stored inline. > >> * @value: Value of the property when it is stored inline. > > > >> + * @u8_data: @value as an array of u8 numbers > >> + * @u16_data: @value as an array of u16 numbers > >> + * @u32_data: @value as an array of u32 numbers > >> + * @u64_data: @value as an array of u64 numbers > >> + * @str: @value as an array of char pointers > > > > I think the proper fix is to add > > > > /* private: internal representation of @value */ > > > >> */ > > OK :) FWIW, while checking this, I found that kernel-doc seems missing the case as above, so the proper handling via @value.u8_data: and so on doesn't work because it's wrapped in anonymous union, and there is no such examples in the documentation. In any case, those fields are indeed private (or in C++ terms more like "protected"). Hence my above suggestion is the way to go. -- With Best Regards, Andy Shevchenko