[PATCH v3] driver/usb MODULE_DESCRIPTION entries to usb modules

[PATCH v3] driver/usb MODULE_DESCRIPTION entries to usb modules

[Rob Gill]

The user tool modinfo is used to get information on kernel modules, including a
description where it is available.

This patch adds a brief MODULE_DESCRIPTION to the following modules in driver/usb.

isight_firmware
mxuport
u_ether
uas

Signed-off-by: Rob Gill <rrobgill@protonmail.com>

---
 drivers/usb/gadget/function/u_ether.c | 1 +
 drivers/usb/misc/isight_firmware.c    | 1 +
 drivers/usb/serial/mxuport.c          | 1 +
 drivers/usb/storage/uas.c             | 1 +
 4 files changed, 4 insertions(+)

diff --git a/drivers/usb/gadget/function/u_ether.c b/drivers/usb/gadget/function/u_ether.c
index fbe96ef1a..424a3a0a4 100644
--- a/drivers/usb/gadget/function/u_ether.c
+++ b/drivers/usb/gadget/function/u_ether.c
@@ -1180,3 +1180,4 @@ EXPORT_SYMBOL_GPL(gether_disconnect);
 
 MODULE_LICENSE("GPL");
 MODULE_AUTHOR("David Brownell");
+MODULE_DESCRIPTION("Ethernet-over-USB Gadget");
diff --git a/drivers/usb/misc/isight_firmware.c b/drivers/usb/misc/isight_firmware.c
index 4d30095d6..925a5682f 100644
--- a/drivers/usb/misc/isight_firmware.c
+++ b/drivers/usb/misc/isight_firmware.c
@@ -129,3 +129,4 @@ module_usb_driver(isight_firmware_driver);
 
 MODULE_LICENSE("GPL");
 MODULE_AUTHOR("Matthew Garrett <mjg@redhat.com>");
+MODULE_DESCRIPTION("USB isight camera firmware loader");
diff --git a/drivers/usb/serial/mxuport.c b/drivers/usb/serial/mxuport.c
index 2513ee902..c1d70d528 100644
--- a/drivers/usb/serial/mxuport.c
+++ b/drivers/usb/serial/mxuport.c
@@ -1323,3 +1323,4 @@ module_usb_serial_driver(serial_drivers, mxuport_idtable);
 MODULE_AUTHOR("Andrew Lunn <andrew@lunn.ch>");
 MODULE_AUTHOR("<support@moxa.com>");
 MODULE_LICENSE("GPL");
+MODULE_DESCRIPTION("MOXA UPort series driver");
diff --git a/drivers/usb/storage/uas.c b/drivers/usb/storage/uas.c
index d59207111..7f59748c4 100644
--- a/drivers/usb/storage/uas.c
+++ b/drivers/usb/storage/uas.c
@@ -1272,3 +1272,4 @@ MODULE_LICENSE("GPL");
 MODULE_IMPORT_NS(USB_STORAGE);
 MODULE_AUTHOR(
 	"Hans de Goede <hdegoede@redhat.com>, Matthew Wilcox and Sarah Sharp");
+MODULE_DESCRIPTION("USB attached SCSI");
-- 
2.17.1



** Descriptions updated after review, thankyou.

Re: [PATCH v3] driver/usb MODULE_DESCRIPTION entries to usb modules

[Johan Hovold]

On Fri, Jun 19, 2020 at 01:31:48PM +0000, Rob Gill wrote:
> The user tool modinfo is used to get information on kernel modules, including a
> description where it is available.
> 
> This patch adds a brief MODULE_DESCRIPTION to the following modules in driver/usb.
> 
> isight_firmware
> mxuport
> u_ether
> uas

We have literally thousands of modules without a module description, so
why this arbitrary and incomplete set?

If the driver author did not care to add a description I don't think we
should go adding mostly pointless descriptions to all those drivers now.

> Signed-off-by: Rob Gill <rrobgill@protonmail.com>
> 
> ---
>  drivers/usb/gadget/function/u_ether.c | 1 +
>  drivers/usb/misc/isight_firmware.c    | 1 +
>  drivers/usb/serial/mxuport.c          | 1 +
>  drivers/usb/storage/uas.c             | 1 +
>  4 files changed, 4 insertions(+)

Johan

Re: [PATCH v3] driver/usb MODULE_DESCRIPTION entries to usb modules

[Greg KH]

On Fri, Jun 19, 2020 at 01:31:48PM +0000, Rob Gill wrote:
> The user tool modinfo is used to get information on kernel modules, including a
> description where it is available.
> 
> This patch adds a brief MODULE_DESCRIPTION to the following modules in driver/usb.
> 
> isight_firmware
> mxuport
> u_ether
> uas
> 
> Signed-off-by: Rob Gill <rrobgill@protonmail.com>
> 
> ---
>  drivers/usb/gadget/function/u_ether.c | 1 +
>  drivers/usb/misc/isight_firmware.c    | 1 +
>  drivers/usb/serial/mxuport.c          | 1 +
>  drivers/usb/storage/uas.c             | 1 +
>  4 files changed, 4 insertions(+)

What changed from previous versions of this patch?  That always goes
under the --- line as the documentation asks for.

Can you fix that up and do a v4?

Also, please use the output of scripts/get_maintainers.pl to determine
who to cc: on your patches.

thanks,

greg k-h