diff mbox series

[net-next,04/22] net: fill in MODULE_DESCRIPTION()s for Broadcom bgmac

Message ID 20240122184543.2501493-5-leitao@debian.org (mailing list archive)
State Changes Requested
Delegated to: Netdev Maintainers
Headers show
Series [net-next,01/22] net: fill in MODULE_DESCRIPTION()s for 8390 | expand

Commit Message

Breno Leitao Jan. 22, 2024, 6:45 p.m. UTC
W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
Add descriptions to the Broadcom iProc GBit driver.

Signed-off-by: Breno Leitao <leitao@debian.org>
---
 drivers/net/ethernet/broadcom/bcm4908_enet.c    | 1 +
 drivers/net/ethernet/broadcom/bgmac-bcma-mdio.c | 1 +
 drivers/net/ethernet/broadcom/bgmac-bcma.c      | 1 +
 drivers/net/ethernet/broadcom/bgmac-platform.c  | 1 +
 drivers/net/ethernet/broadcom/bgmac.c           | 1 +
 5 files changed, 5 insertions(+)

Comments

Florian Fainelli Jan. 22, 2024, 6:50 p.m. UTC | #1
On 1/22/24 10:45, Breno Leitao wrote:
> W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> Add descriptions to the Broadcom iProc GBit driver.
> 
> Signed-off-by: Breno Leitao <leitao@debian.org>
> ---
>   drivers/net/ethernet/broadcom/bcm4908_enet.c    | 1 +
>   drivers/net/ethernet/broadcom/bgmac-bcma-mdio.c | 1 +
>   drivers/net/ethernet/broadcom/bgmac-bcma.c      | 1 +
>   drivers/net/ethernet/broadcom/bgmac-platform.c  | 1 +
>   drivers/net/ethernet/broadcom/bgmac.c           | 1 +
>   5 files changed, 5 insertions(+)
> 
> diff --git a/drivers/net/ethernet/broadcom/bcm4908_enet.c b/drivers/net/ethernet/broadcom/bcm4908_enet.c
> index 3e7c8671cd11..a6bc5ce70230 100644
> --- a/drivers/net/ethernet/broadcom/bcm4908_enet.c
> +++ b/drivers/net/ethernet/broadcom/bcm4908_enet.c
> @@ -793,5 +793,6 @@ static struct platform_driver bcm4908_enet_driver = {
>   };
>   module_platform_driver(bcm4908_enet_driver);
>   
> +MODULE_DESCRIPTION("Broadcom iProc GBit Ethernet driver");

This should be:

Broadcom BCM4908 Gigabit Ethernet driver

>   MODULE_LICENSE("GPL v2");
>   MODULE_DEVICE_TABLE(of, bcm4908_enet_of_match);
> diff --git a/drivers/net/ethernet/broadcom/bgmac-bcma-mdio.c b/drivers/net/ethernet/broadcom/bgmac-bcma-mdio.c
> index 9b83d5361699..50b8e97a811d 100644
> --- a/drivers/net/ethernet/broadcom/bgmac-bcma-mdio.c
> +++ b/drivers/net/ethernet/broadcom/bgmac-bcma-mdio.c
> @@ -260,4 +260,5 @@ void bcma_mdio_mii_unregister(struct mii_bus *mii_bus)
>   EXPORT_SYMBOL_GPL(bcma_mdio_mii_unregister);
>   
>   MODULE_AUTHOR("Rafał Miłecki");
> +MODULE_DESCRIPTION("Broadcom iProc GBit BCMA MDIO helpers");
>   MODULE_LICENSE("GPL");
> diff --git a/drivers/net/ethernet/broadcom/bgmac-bcma.c b/drivers/net/ethernet/broadcom/bgmac-bcma.c
> index 6e4f36aaf5db..6c53ea522daf 100644
> --- a/drivers/net/ethernet/broadcom/bgmac-bcma.c
> +++ b/drivers/net/ethernet/broadcom/bgmac-bcma.c
> @@ -362,4 +362,5 @@ module_init(bgmac_init)
>   module_exit(bgmac_exit)
>   
>   MODULE_AUTHOR("Rafał Miłecki");
> +MODULE_DESCRIPTION("Broadcom iProc GBit BCMA helpers");

Broadcom iProc GBit BCMA interface driver

>   MODULE_LICENSE("GPL");
> diff --git a/drivers/net/ethernet/broadcom/bgmac-platform.c b/drivers/net/ethernet/broadcom/bgmac-platform.c
> index 0b21fd5bd457..5bdd875831f1 100644
> --- a/drivers/net/ethernet/broadcom/bgmac-platform.c
> +++ b/drivers/net/ethernet/broadcom/bgmac-platform.c
> @@ -298,4 +298,5 @@ static struct platform_driver bgmac_enet_driver = {
>   };
>   
>   module_platform_driver(bgmac_enet_driver);
> +MODULE_DESCRIPTION("Broadcom iProc GBit platform");

Broadcom iProc GBit platform interface driver

>   MODULE_LICENSE("GPL");
> diff --git a/drivers/net/ethernet/broadcom/bgmac.c b/drivers/net/ethernet/broadcom/bgmac.c
> index 448a1b90de5e..6ffdc4229407 100644
> --- a/drivers/net/ethernet/broadcom/bgmac.c
> +++ b/drivers/net/ethernet/broadcom/bgmac.c
> @@ -1626,4 +1626,5 @@ int bgmac_enet_resume(struct bgmac *bgmac)
>   EXPORT_SYMBOL_GPL(bgmac_enet_resume);
>   
>   MODULE_AUTHOR("Rafał Miłecki");
> +MODULE_DESCRIPTION("Broadcom iProc GBit driver");
>   MODULE_LICENSE("GPL");

pw-bot: cr
Breno Leitao Jan. 22, 2024, 7:01 p.m. UTC | #2
On Mon, Jan 22, 2024 at 10:50:32AM -0800, Florian Fainelli wrote:
> On 1/22/24 10:45, Breno Leitao wrote:
> > W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
> > Add descriptions to the Broadcom iProc GBit driver.
> > 
> > Signed-off-by: Breno Leitao <leitao@debian.org>
> > ---
> >   drivers/net/ethernet/broadcom/bcm4908_enet.c    | 1 +
> >   drivers/net/ethernet/broadcom/bgmac-bcma-mdio.c | 1 +
> >   drivers/net/ethernet/broadcom/bgmac-bcma.c      | 1 +
> >   drivers/net/ethernet/broadcom/bgmac-platform.c  | 1 +
> >   drivers/net/ethernet/broadcom/bgmac.c           | 1 +
> >   5 files changed, 5 insertions(+)
> > 
> > diff --git a/drivers/net/ethernet/broadcom/bcm4908_enet.c b/drivers/net/ethernet/broadcom/bcm4908_enet.c
> > index 3e7c8671cd11..a6bc5ce70230 100644
> > --- a/drivers/net/ethernet/broadcom/bcm4908_enet.c
> > +++ b/drivers/net/ethernet/broadcom/bcm4908_enet.c
> > @@ -793,5 +793,6 @@ static struct platform_driver bcm4908_enet_driver = {
> >   };
> >   module_platform_driver(bcm4908_enet_driver);
> > +MODULE_DESCRIPTION("Broadcom iProc GBit Ethernet driver");
> 
> This should be:
> 
> Broadcom BCM4908 Gigabit Ethernet driver

Thanks. I will update in v2.
diff mbox series

Patch

diff --git a/drivers/net/ethernet/broadcom/bcm4908_enet.c b/drivers/net/ethernet/broadcom/bcm4908_enet.c
index 3e7c8671cd11..a6bc5ce70230 100644
--- a/drivers/net/ethernet/broadcom/bcm4908_enet.c
+++ b/drivers/net/ethernet/broadcom/bcm4908_enet.c
@@ -793,5 +793,6 @@  static struct platform_driver bcm4908_enet_driver = {
 };
 module_platform_driver(bcm4908_enet_driver);
 
+MODULE_DESCRIPTION("Broadcom iProc GBit Ethernet driver");
 MODULE_LICENSE("GPL v2");
 MODULE_DEVICE_TABLE(of, bcm4908_enet_of_match);
diff --git a/drivers/net/ethernet/broadcom/bgmac-bcma-mdio.c b/drivers/net/ethernet/broadcom/bgmac-bcma-mdio.c
index 9b83d5361699..50b8e97a811d 100644
--- a/drivers/net/ethernet/broadcom/bgmac-bcma-mdio.c
+++ b/drivers/net/ethernet/broadcom/bgmac-bcma-mdio.c
@@ -260,4 +260,5 @@  void bcma_mdio_mii_unregister(struct mii_bus *mii_bus)
 EXPORT_SYMBOL_GPL(bcma_mdio_mii_unregister);
 
 MODULE_AUTHOR("Rafał Miłecki");
+MODULE_DESCRIPTION("Broadcom iProc GBit BCMA MDIO helpers");
 MODULE_LICENSE("GPL");
diff --git a/drivers/net/ethernet/broadcom/bgmac-bcma.c b/drivers/net/ethernet/broadcom/bgmac-bcma.c
index 6e4f36aaf5db..6c53ea522daf 100644
--- a/drivers/net/ethernet/broadcom/bgmac-bcma.c
+++ b/drivers/net/ethernet/broadcom/bgmac-bcma.c
@@ -362,4 +362,5 @@  module_init(bgmac_init)
 module_exit(bgmac_exit)
 
 MODULE_AUTHOR("Rafał Miłecki");
+MODULE_DESCRIPTION("Broadcom iProc GBit BCMA helpers");
 MODULE_LICENSE("GPL");
diff --git a/drivers/net/ethernet/broadcom/bgmac-platform.c b/drivers/net/ethernet/broadcom/bgmac-platform.c
index 0b21fd5bd457..5bdd875831f1 100644
--- a/drivers/net/ethernet/broadcom/bgmac-platform.c
+++ b/drivers/net/ethernet/broadcom/bgmac-platform.c
@@ -298,4 +298,5 @@  static struct platform_driver bgmac_enet_driver = {
 };
 
 module_platform_driver(bgmac_enet_driver);
+MODULE_DESCRIPTION("Broadcom iProc GBit platform");
 MODULE_LICENSE("GPL");
diff --git a/drivers/net/ethernet/broadcom/bgmac.c b/drivers/net/ethernet/broadcom/bgmac.c
index 448a1b90de5e..6ffdc4229407 100644
--- a/drivers/net/ethernet/broadcom/bgmac.c
+++ b/drivers/net/ethernet/broadcom/bgmac.c
@@ -1626,4 +1626,5 @@  int bgmac_enet_resume(struct bgmac *bgmac)
 EXPORT_SYMBOL_GPL(bgmac_enet_resume);
 
 MODULE_AUTHOR("Rafał Miłecki");
+MODULE_DESCRIPTION("Broadcom iProc GBit driver");
 MODULE_LICENSE("GPL");