linux-kernel - Re: [PATCH] scsi: 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] [thread-next>] [day] [month] [year] [list]

Message-ID: <82cdd602-8faf-5cc0-c0b4-87ff1d820474@linux-m68k.org>
Date: Sat, 8 Jun 2024 10:52:45 +1000 (AEST)
From: Finn Thain <fthain@...ux-m68k.org>
To: Jeff Johnson <quic_jjohnson@...cinc.com>
cc: Khalid Aziz <khalid@...ehiking.org>, 
    "James E.J. Bottomley" <James.Bottomley@...senPartnership.com>, 
    "Martin K. Petersen" <martin.petersen@...cle.com>, 
    Matthew Wilcox <willy@...radead.org>, Hannes Reinecke <hare@...e.com>, 
    Michael Schmitz <schmitzmic@...il.com>, 
    James Smart <james.smart@...adcom.com>, 
    Ram Vegesna <ram.vegesna@...adcom.com>, 
    Artur Paszkiewicz <artur.paszkiewicz@...el.com>, 
    "Juergen E. Fischer" <fischer@...bit.de>, linux-scsi@...r.kernel.org, 
    linux-kernel@...r.kernel.org, target-devel@...r.kernel.org, 
    kernel-janitors@...r.kernel.org
Subject: Re: [PATCH] scsi: add missing MODULE_DESCRIPTION() macros


On Fri, 7 Jun 2024, Jeff Johnson wrote:

> diff --git a/drivers/scsi/atari_scsi.c b/drivers/scsi/atari_scsi.c
> index 742625ac7d99..4eb5770aeef5 100644
> --- a/drivers/scsi/atari_scsi.c
> +++ b/drivers/scsi/atari_scsi.c
> @@ -894,4 +894,5 @@ static struct platform_driver atari_scsi_driver __refdata = {
>  module_platform_driver_probe(atari_scsi_driver, atari_scsi_probe);
>  
>  MODULE_ALIAS("platform:" DRV_MODULE_NAME);
> +MODULE_DESCRIPTION("Atari generic SCSI port driver");
>  MODULE_LICENSE("GPL");

"Atari NCR5380 SCSI driver", please. I don't think the word "generic" 
applies here. It was a reference to the "generic NCR5380 driver by Drew 
Eckhardt" from which specialized drivers like this one were derived.

> diff --git a/drivers/scsi/g_NCR5380.c b/drivers/scsi/g_NCR5380.c
> index f6305e3e60f4..1bef131664e0 100644
> --- a/drivers/scsi/g_NCR5380.c
> +++ b/drivers/scsi/g_NCR5380.c
> @@ -110,6 +110,7 @@ module_param_array(card, int, NULL, 0);
>  MODULE_PARM_DESC(card, "card type (0=NCR5380, 1=NCR53C400, 2=NCR53C400A, 3=DTC3181E, 4=HP C2502)");
>  
>  MODULE_ALIAS("g_NCR5380_mmio");
> +MODULE_DESCRIPTION("Generic NCR5380 driver");
>  MODULE_LICENSE("GPL");
>  
>  static void g_NCR5380_trigger_irq(struct Scsi_Host *instance)

"Generic NCR5380/NCR53C400 SCSI driver" please.

This driver actually describes itself as "generic generic NCR5380 driver" 
which appears to be a joke. The term "generic" was used to mean universal 
i.e. intended to cover every ISA card implementation.

> diff --git a/drivers/scsi/initio.c b/drivers/scsi/initio.c
> index 625fd547ee60..82d8b8f8293f 100644
> --- a/drivers/scsi/initio.c
> +++ b/drivers/scsi/initio.c
> @@ -2939,6 +2939,7 @@ static void initio_remove_one(struct pci_dev *pdev)
>  	pci_disable_device(pdev);
>  }
>  
> +MODULE_DESCRIPTION("Initio 9100U(W) driver");
>  MODULE_LICENSE("GPL");
>  
>  static struct pci_device_id initio_pci_tbl[] = {
> @@ -2961,4 +2962,5 @@ module_pci_driver(initio_pci_driver);
>  
>  MODULE_DESCRIPTION("Initio INI-9X00U/UW SCSI device driver");
>  MODULE_AUTHOR("Initio Corporation");
> +MODULE_DESCRIPTION("TBD");
>  MODULE_LICENSE("GPL");

There are now three MODULE_DESCRIPTION macros here.

> diff --git a/drivers/scsi/mac_scsi.c b/drivers/scsi/mac_scsi.c
> index a402c4dc4645..f74231ca29e5 100644
> --- a/drivers/scsi/mac_scsi.c
> +++ b/drivers/scsi/mac_scsi.c
> @@ -550,4 +550,5 @@ static struct platform_driver mac_scsi_driver __refdata = {
>  module_platform_driver_probe(mac_scsi_driver, mac_scsi_probe);
>  
>  MODULE_ALIAS("platform:" DRV_MODULE_NAME);
> +MODULE_DESCRIPTION("Generic Macintosh NCR5380 driver");
>  MODULE_LICENSE("GPL");


"Macintosh NCR5380 SCSI driver", please.

> diff --git a/drivers/scsi/sr.c b/drivers/scsi/sr.c
> index 7ab000942b97..c4a88f673183 100644
> --- a/drivers/scsi/sr.c
> +++ b/drivers/scsi/sr.c
> @@ -68,6 +68,7 @@
>  
>  
>  MODULE_DESCRIPTION("SCSI cdrom (sr) driver");
> +MODULE_DESCRIPTION("TBD");
>  MODULE_LICENSE("GPL");
>  MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_CDROM_MAJOR);
>  MODULE_ALIAS_SCSI_DEVICE(TYPE_ROM);
> @@ -1007,4 +1008,5 @@ static void __exit exit_sr(void)
>  
>  module_init(init_sr);
>  module_exit(exit_sr);
> +MODULE_DESCRIPTION("SCSI CDROM driver");
>  MODULE_LICENSE("GPL");

Three macros here also.