Re: [PATCH] usb: add missing MODULE_DESCRIPTION() macros
From: Jeff Johnson
Date: Wed Jun 12 2024 - 14:21:42 EST
On 6/12/2024 11:16 AM, Alan Stern wrote:
> On Tue, Jun 11, 2024 at 07:37:20PM -0700, Jeff Johnson wrote:
>> With ARCH=x86, make allmodconfig && make W=1 C=1 reports:
>> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/usb/core/usbcore.o
>> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/usb/mon/usbmon.o
>> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/usb/class/usbtmc.o
>> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/usb/storage/uas.o
>> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/usb/chipidea/ci_hdrc_msm.o
>>
>> Add the missing invocations of the MODULE_DESCRIPTION() macro.
>>
>> Signed-off-by: Jeff Johnson <quic_jjohnson@xxxxxxxxxxx>
>> ---
>> This is the remaining one-off fixes in usb.
>>
>> Corrections to these descriptions are welcomed. I'm not an expert in
>> this code so in most cases I've taken these descriptions directly from
>> code comments, Kconfig descriptions, or git logs. History has shown
>> that in some cases these are originally wrong due to cut-n-paste
>> errors, and in other cases the drivers have evolved such that the
>> original information is no longer accurate.
>>
>> Let me know if any of these changes need to be segregated into
>> separate patches to go through different maintainer trees.
>
>> diff --git a/drivers/usb/core/usb.c b/drivers/usb/core/usb.c
>> index a0c432b14b20..65f9940bc7e8 100644
>> --- a/drivers/usb/core/usb.c
>> +++ b/drivers/usb/core/usb.c
>> @@ -1150,4 +1150,5 @@ static void __exit usb_exit(void)
>>
>> subsys_initcall(usb_init);
>> module_exit(usb_exit);
>> +MODULE_DESCRIPTION("USB support library");
>> MODULE_LICENSE("GPL");
>
> I would change this to "USB core host-side support", or something more
> along those lines. It's not just a library because it does include
> several drivers (such as the USB hub driver). And it's host-side rather
> than device-side -- that's a separate module.
>
> Alan Stern
thanks, will reword in the next version
/jeff