linux-kernel - Re: [PATCH] usb: add missing MODULE

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <4300d6a0-66be-4a5d-8c3d-c43043106c4d@quicinc.com>
Date: Wed, 12 Jun 2024 11:21:03 -0700
From: Jeff Johnson <quic_jjohnson@...cinc.com>
To: Alan Stern <stern@...land.harvard.edu>
CC: Peter Chen <peter.chen@...nel.org>,
        Greg Kroah-Hartman
	<gregkh@...uxfoundation.org>,
        Oliver Neukum <oneukum@...e.com>, <linux-usb@...r.kernel.org>,
        <linux-kernel@...r.kernel.org>, <linux-scsi@...r.kernel.org>,
        <usb-storage@...ts.one-eyed-alien.net>,
        <kernel-janitors@...r.kernel.org>
Subject: Re: [PATCH] usb: add missing MODULE_DESCRIPTION() macros

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@...cinc.com>
>> ---
>> 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