netdev - Re: [PATCH net-next 4/4] net: fill in 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: <CAM0EoMnGTeMg4xgQh2JfKYtrV=WbdkBNoeNLp72txjcR5qRB6Q@mail.gmail.com>
Date: Thu, 26 Oct 2023 18:46:41 -0400
From: Jamal Hadi Salim <jhs@...atatu.com>
To: Jakub Kicinski <kuba@...nel.org>
Cc: davem@...emloft.net, netdev@...r.kernel.org, edumazet@...gle.com, 
	pabeni@...hat.com, arnd@...db.de, ap420073@...il.com, 
	willemdebruijn.kernel@...il.com, jasowang@...hat.com
Subject: Re: [PATCH net-next 4/4] net: fill in MODULE_DESCRIPTION()s under drivers/net/

On Thu, Oct 26, 2023 at 3:01 PM Jakub Kicinski <kuba@...nel.org> wrote:
>
> W=1 builds now warn if module is built without a MODULE_DESCRIPTION().
>
> Signed-off-by: Jakub Kicinski <kuba@...nel.org>
> ---
> CC: jhs@...atatu.com
> CC: arnd@...db.de
> CC: ap420073@...il.com
> CC: willemdebruijn.kernel@...il.com
> CC: jasowang@...hat.com
> ---
>  drivers/net/amt.c        | 1 +
>  drivers/net/dummy.c      | 1 +
>  drivers/net/eql.c        | 1 +
>  drivers/net/ifb.c        | 1 +
>  drivers/net/macvtap.c    | 1 +
>  drivers/net/sungem_phy.c | 1 +
>  drivers/net/tap.c        | 1 +
>  7 files changed, 7 insertions(+)
>
> diff --git a/drivers/net/amt.c b/drivers/net/amt.c
> index 2d20be6ffb7e..53415e83821c 100644
> --- a/drivers/net/amt.c
> +++ b/drivers/net/amt.c
> @@ -3449,5 +3449,6 @@ static void __exit amt_fini(void)
>  module_exit(amt_fini);
>
>  MODULE_LICENSE("GPL");
> +MODULE_DESCRIPTION("Driver for Automatic Multicast Tunneling (AMT)");
>  MODULE_AUTHOR("Taehee Yoo <ap420073@...il.com>");
>  MODULE_ALIAS_RTNL_LINK("amt");
> diff --git a/drivers/net/dummy.c b/drivers/net/dummy.c
> index c4b1b0aa438a..768454aa36d6 100644
> --- a/drivers/net/dummy.c
> +++ b/drivers/net/dummy.c
> @@ -202,4 +202,5 @@ static void __exit dummy_cleanup_module(void)
>  module_init(dummy_init_module);
>  module_exit(dummy_cleanup_module);
>  MODULE_LICENSE("GPL");
> +MODULE_DESCRIPTION("Dummy netdevice driver which discards all packets sent to it");
>  MODULE_ALIAS_RTNL_LINK(DRV_NAME);
> diff --git a/drivers/net/eql.c b/drivers/net/eql.c
> index ca3e4700a813..3c2efda916f1 100644
> --- a/drivers/net/eql.c
> +++ b/drivers/net/eql.c
> @@ -607,4 +607,5 @@ static void __exit eql_cleanup_module(void)
>
>  module_init(eql_init_module);
>  module_exit(eql_cleanup_module);
> +MODULE_DESCRIPTION("Equalizer Load-balancer for serial network interfaces");
>  MODULE_LICENSE("GPL");
> diff --git a/drivers/net/ifb.c b/drivers/net/ifb.c
> index 78253ad57b2e..2c1b5def4a0b 100644
> --- a/drivers/net/ifb.c
> +++ b/drivers/net/ifb.c
> @@ -454,5 +454,6 @@ static void __exit ifb_cleanup_module(void)
>  module_init(ifb_init_module);
>  module_exit(ifb_cleanup_module);
>  MODULE_LICENSE("GPL");
> +MODULE_DESCRIPTION("Intermediate Functional Block (ifb) netdevice driver for sharing of resources and ingress packet queuing");
>  MODULE_AUTHOR("Jamal Hadi Salim");
>  MODULE_ALIAS_RTNL_LINK("ifb");


Acked-by: Jamal Hadi Salim <jhs@...atatu.com>

cheers,
jamal
> diff --git a/drivers/net/macvtap.c b/drivers/net/macvtap.c
> index bddcc127812e..29a5929d48e5 100644


> --- a/drivers/net/macvtap.c
> +++ b/drivers/net/macvtap.c
> @@ -250,5 +250,6 @@ static void __exit macvtap_exit(void)
>  module_exit(macvtap_exit);
>
>  MODULE_ALIAS_RTNL_LINK("macvtap");
> +MODULE_DESCRIPTION("MAC-VLAN based tap driver");
>  MODULE_AUTHOR("Arnd Bergmann <arnd@...db.de>");
>  MODULE_LICENSE("GPL");
> diff --git a/drivers/net/sungem_phy.c b/drivers/net/sungem_phy.c
> index 36803d932dff..d591e33268e5 100644
> --- a/drivers/net/sungem_phy.c
> +++ b/drivers/net/sungem_phy.c
> @@ -1194,4 +1194,5 @@ int sungem_phy_probe(struct mii_phy *phy, int mii_id)
>  }
>
>  EXPORT_SYMBOL(sungem_phy_probe);
> +MODULE_DESCRIPTION("PHY drivers for the sungem Ethernet MAC driver");
>  MODULE_LICENSE("GPL");
> diff --git a/drivers/net/tap.c b/drivers/net/tap.c
> index 5c01cc7b9949..9f0495e8df4d 100644
> --- a/drivers/net/tap.c
> +++ b/drivers/net/tap.c
> @@ -1399,6 +1399,7 @@ void tap_destroy_cdev(dev_t major, struct cdev *tap_cdev)
>  }
>  EXPORT_SYMBOL_GPL(tap_destroy_cdev);
>
> +MODULE_DESCRIPTION("Common library for drivers implementing the TAP interface");
>  MODULE_AUTHOR("Arnd Bergmann <arnd@...db.de>");
>  MODULE_AUTHOR("Sainath Grandhi <sainath.grandhi@...el.com>");
>  MODULE_LICENSE("GPL");
> --
> 2.41.0
>