diff mbox series

regulator: add missing MODULE_DESCRIPTION() macro

Message ID 20240608-md-drivers-regulator-v1-1-da338665db7a@quicinc.com (mailing list archive)
State New
Headers show
Series regulator: add missing MODULE_DESCRIPTION() macro | expand

Commit Message

Jeff Johnson June 9, 2024, 4:53 a.m. UTC 
On x86, make allmodconfig && make W=1 C=1 reports:
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/regulator/da9121-regulator.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/regulator/max20411-regulator.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/regulator/rt4831-regulator.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/regulator/tps6286x-regulator.o

Add the missing invocation of the MODULE_DESCRIPTION() macro to all files
which have a MODULE_LICENSE(). This includes mtk-dvfsrc-regulator.c, which
did not produce a warning with the x86 allmodconfig, since it may cause
this warning with other configurations.

Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
---
 drivers/regulator/da9121-regulator.c     | 1 +
 drivers/regulator/max20411-regulator.c   | 1 +
 drivers/regulator/mtk-dvfsrc-regulator.c | 1 +
 drivers/regulator/rt4831-regulator.c     | 1 +
 drivers/regulator/tps6286x-regulator.c   | 1 +
 5 files changed, 5 insertions(+)


---
base-commit: 19ca0d8a433ff37018f9429f7e7739e9f3d3d2b4
change-id: 20240608-md-drivers-regulator-223215da0e16

Comments

AngeloGioacchino Del Regno June 10, 2024, 8:43 a.m. UTC | #1 
Il 09/06/24 06:53, Jeff Johnson ha scritto:
> On x86, make allmodconfig && make W=1 C=1 reports:
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/regulator/da9121-regulator.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/regulator/max20411-regulator.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/regulator/rt4831-regulator.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/regulator/tps6286x-regulator.o
> 
> Add the missing invocation of the MODULE_DESCRIPTION() macro to all files
> which have a MODULE_LICENSE(). This includes mtk-dvfsrc-regulator.c, which
> did not produce a warning with the x86 allmodconfig, since it may cause
> this warning with other configurations.
> 
> Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
> ---
>   drivers/regulator/da9121-regulator.c     | 1 +
>   drivers/regulator/max20411-regulator.c   | 1 +
>   drivers/regulator/mtk-dvfsrc-regulator.c | 1 +
>   drivers/regulator/rt4831-regulator.c     | 1 +
>   drivers/regulator/tps6286x-regulator.c   | 1 +
>   5 files changed, 5 insertions(+)
> 
> diff --git a/drivers/regulator/da9121-regulator.c b/drivers/regulator/da9121-regulator.c
> index 96257551bb12..3571b6242e3a 100644
> --- a/drivers/regulator/da9121-regulator.c
> +++ b/drivers/regulator/da9121-regulator.c
> @@ -1192,4 +1192,5 @@ static struct i2c_driver da9121_regulator_driver = {
>   
>   module_i2c_driver(da9121_regulator_driver);
>   
> +MODULE_DESCRIPTION("Dialog Semiconductor DA9121/DA9122/DA9220/DA9217/DA9130/DA9131/DA9132 regulator driver");
>   MODULE_LICENSE("GPL v2");
> diff --git a/drivers/regulator/max20411-regulator.c b/drivers/regulator/max20411-regulator.c
> index 8c09dc71b16d..6614e767072f 100644
> --- a/drivers/regulator/max20411-regulator.c
> +++ b/drivers/regulator/max20411-regulator.c
> @@ -161,4 +161,5 @@ static struct i2c_driver max20411_i2c_driver = {
>   };
>   module_i2c_driver(max20411_i2c_driver);
>   
> +MODULE_DESCRIPTION("Maxim MAX20411 High-Efficiency Single Step-Down Converter driver");
>   MODULE_LICENSE("GPL");
> diff --git a/drivers/regulator/mtk-dvfsrc-regulator.c b/drivers/regulator/mtk-dvfsrc-regulator.c
> index f1280d45265d..1941aad5e247 100644
> --- a/drivers/regulator/mtk-dvfsrc-regulator.c
> +++ b/drivers/regulator/mtk-dvfsrc-regulator.c
> @@ -211,4 +211,5 @@ static void __exit mtk_dvfsrc_regulator_exit(void)
>   module_exit(mtk_dvfsrc_regulator_exit);
>   
>   MODULE_AUTHOR("Arvin wang <arvin.wang@mediatek.com>");
> +MODULE_DESCRIPTION("MediaTek DVFSRC regulator driver");

Can you please drop this one?
I have a series floating that is removing this driver entirely and replacing it
with a refactored one. Though, it has the same issue, so I'll have to send a v6.

Anyway, v5 is there:

https://lore.kernel.org/r/20240424095416.1105639-1-angelogioacchino.delregno@collabora.com


>   MODULE_LICENSE("GPL v2");
> diff --git a/drivers/regulator/rt4831-regulator.c b/drivers/regulator/rt4831-regulator.c
> index 97e6f7e2a0ba..7d1ba0c82271 100644
> --- a/drivers/regulator/rt4831-regulator.c
> +++ b/drivers/regulator/rt4831-regulator.c
> @@ -202,4 +202,5 @@ static struct platform_driver rt4831_regulator_driver = {
>   module_platform_driver(rt4831_regulator_driver);
>   
>   MODULE_AUTHOR("ChiYuan Huang <cy_huang@richtek.com>");
> +MODULE_DESCRIPTION("Richtek RT4831 DSV RegulatorsRichtek RT4831 DSV Regulators driver");

Also, there's a typo here :-)

After dropping mtk-dvfsrc-regulator changes and after fixing the typo:

Reviewed-by: AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com>
Jeff Johnson June 10, 2024, 2:22 p.m. UTC | #2 
On 6/10/2024 1:43 AM, AngeloGioacchino Del Regno wrote:
> Il 09/06/24 06:53, Jeff Johnson ha scritto:
>> On x86, make allmodconfig && make W=1 C=1 reports:
>> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/regulator/da9121-regulator.o
>> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/regulator/max20411-regulator.o
>> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/regulator/rt4831-regulator.o
>> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/regulator/tps6286x-regulator.o
>>
>> Add the missing invocation of the MODULE_DESCRIPTION() macro to all files
>> which have a MODULE_LICENSE(). This includes mtk-dvfsrc-regulator.c, which
>> did not produce a warning with the x86 allmodconfig, since it may cause
>> this warning with other configurations.
>>
>> Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
>> ---
>>   drivers/regulator/da9121-regulator.c     | 1 +
>>   drivers/regulator/max20411-regulator.c   | 1 +
>>   drivers/regulator/mtk-dvfsrc-regulator.c | 1 +
>>   drivers/regulator/rt4831-regulator.c     | 1 +
>>   drivers/regulator/tps6286x-regulator.c   | 1 +
>>   5 files changed, 5 insertions(+)
>>
>> diff --git a/drivers/regulator/da9121-regulator.c b/drivers/regulator/da9121-regulator.c
>> index 96257551bb12..3571b6242e3a 100644
>> --- a/drivers/regulator/da9121-regulator.c
>> +++ b/drivers/regulator/da9121-regulator.c
>> @@ -1192,4 +1192,5 @@ static struct i2c_driver da9121_regulator_driver = {
>>   
>>   module_i2c_driver(da9121_regulator_driver);
>>   
>> +MODULE_DESCRIPTION("Dialog Semiconductor DA9121/DA9122/DA9220/DA9217/DA9130/DA9131/DA9132 regulator driver");
>>   MODULE_LICENSE("GPL v2");
>> diff --git a/drivers/regulator/max20411-regulator.c b/drivers/regulator/max20411-regulator.c
>> index 8c09dc71b16d..6614e767072f 100644
>> --- a/drivers/regulator/max20411-regulator.c
>> +++ b/drivers/regulator/max20411-regulator.c
>> @@ -161,4 +161,5 @@ static struct i2c_driver max20411_i2c_driver = {
>>   };
>>   module_i2c_driver(max20411_i2c_driver);
>>   
>> +MODULE_DESCRIPTION("Maxim MAX20411 High-Efficiency Single Step-Down Converter driver");
>>   MODULE_LICENSE("GPL");
>> diff --git a/drivers/regulator/mtk-dvfsrc-regulator.c b/drivers/regulator/mtk-dvfsrc-regulator.c
>> index f1280d45265d..1941aad5e247 100644
>> --- a/drivers/regulator/mtk-dvfsrc-regulator.c
>> +++ b/drivers/regulator/mtk-dvfsrc-regulator.c
>> @@ -211,4 +211,5 @@ static void __exit mtk_dvfsrc_regulator_exit(void)
>>   module_exit(mtk_dvfsrc_regulator_exit);
>>   
>>   MODULE_AUTHOR("Arvin wang <arvin.wang@mediatek.com>");
>> +MODULE_DESCRIPTION("MediaTek DVFSRC regulator driver");
> 
> Can you please drop this one?
> I have a series floating that is removing this driver entirely and replacing it
> with a refactored one. Though, it has the same issue, so I'll have to send a v6.
> 
> Anyway, v5 is there:
> 
> https://lore.kernel.org/r/20240424095416.1105639-1-angelogioacchino.delregno@collabora.com
> 
> 
>>   MODULE_LICENSE("GPL v2");
>> diff --git a/drivers/regulator/rt4831-regulator.c b/drivers/regulator/rt4831-regulator.c
>> index 97e6f7e2a0ba..7d1ba0c82271 100644
>> --- a/drivers/regulator/rt4831-regulator.c
>> +++ b/drivers/regulator/rt4831-regulator.c
>> @@ -202,4 +202,5 @@ static struct platform_driver rt4831_regulator_driver = {
>>   module_platform_driver(rt4831_regulator_driver);
>>   
>>   MODULE_AUTHOR("ChiYuan Huang <cy_huang@richtek.com>");
>> +MODULE_DESCRIPTION("Richtek RT4831 DSV RegulatorsRichtek RT4831 DSV Regulators driver");
> 
> Also, there's a typo here :-)
> 
> After dropping mtk-dvfsrc-regulator changes and after fixing the typo:
> 
> Reviewed-by: AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com>

Thanks, will address these in v2

/jeff
Jeff Johnson June 10, 2024, 2:43 p.m. UTC | #3 
On 6/10/2024 1:43 AM, AngeloGioacchino Del Regno wrote:
> Il 09/06/24 06:53, Jeff Johnson ha scritto:
>> --- a/drivers/regulator/mtk-dvfsrc-regulator.c
>> +++ b/drivers/regulator/mtk-dvfsrc-regulator.c
>> @@ -211,4 +211,5 @@ static void __exit mtk_dvfsrc_regulator_exit(void)
>>   module_exit(mtk_dvfsrc_regulator_exit);
>>   
>>   MODULE_AUTHOR("Arvin wang <arvin.wang@mediatek.com>");
>> +MODULE_DESCRIPTION("MediaTek DVFSRC regulator driver");
> 
> Can you please drop this one?
> I have a series floating that is removing this driver entirely and replacing it
> with a refactored one. Though, it has the same issue, so I'll have to send a v6.
> 
> Anyway, v5 is there:
> 
> https://lore.kernel.org/r/20240424095416.1105639-1-angelogioacchino.delregno@collabora.com

Your v5 looks fine to me:

+MODULE_AUTHOR("AngeloGioacchino Del Regno <angelogioacchino.delregno@collabora.com>");
+MODULE_AUTHOR("Dawei Chien <dawei.chien@mediatek.com>");
+MODULE_LICENSE("GPL");
+MODULE_DESCRIPTION("MediaTek DVFSRC driver");
Mark Brown June 10, 2024, 9:44 p.m. UTC | #4 
On Sat, 08 Jun 2024 21:53:29 -0700, Jeff Johnson wrote:
> On x86, make allmodconfig && make W=1 C=1 reports:
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/regulator/da9121-regulator.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/regulator/max20411-regulator.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/regulator/rt4831-regulator.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/regulator/tps6286x-regulator.o
> 
> Add the missing invocation of the MODULE_DESCRIPTION() macro to all files
> which have a MODULE_LICENSE(). This includes mtk-dvfsrc-regulator.c, which
> did not produce a warning with the x86 allmodconfig, since it may cause
> this warning with other configurations.
> 
> [...]

Applied to

   https://git.kernel.org/pub/scm/linux/kernel/git/broonie/regulator.git for-next

Thanks!

[1/1] regulator: add missing MODULE_DESCRIPTION() macro
      commit: 8a2744f2955a584188a82d631937aa365d4ea966

All being well this means that it will be integrated into the linux-next
tree (usually sometime in the next 24 hours) and sent to Linus during
the next merge window (or sooner if it is a bug fix), however if
problems are discovered then the patch may be dropped or reverted.

You may get further e-mails resulting from automated or manual testing
and review of the tree, please engage with people reporting problems and
send followup patches addressing any issues that are reported if needed.

If any updates are required or you are submitting further changes they
should be sent as incremental updates against current git, existing
patches will not be replaced.

Please add any relevant lists and maintainers to the CCs when replying
to this mail.

Thanks,
Mark
diff mbox series

Patch

diff --git a/drivers/regulator/da9121-regulator.c b/drivers/regulator/da9121-regulator.c
index 96257551bb12..3571b6242e3a 100644
--- a/drivers/regulator/da9121-regulator.c
+++ b/drivers/regulator/da9121-regulator.c
@@ -1192,4 +1192,5 @@  static struct i2c_driver da9121_regulator_driver = {
 
 module_i2c_driver(da9121_regulator_driver);
 
+MODULE_DESCRIPTION("Dialog Semiconductor DA9121/DA9122/DA9220/DA9217/DA9130/DA9131/DA9132 regulator driver");
 MODULE_LICENSE("GPL v2");
diff --git a/drivers/regulator/max20411-regulator.c b/drivers/regulator/max20411-regulator.c
index 8c09dc71b16d..6614e767072f 100644
--- a/drivers/regulator/max20411-regulator.c
+++ b/drivers/regulator/max20411-regulator.c
@@ -161,4 +161,5 @@  static struct i2c_driver max20411_i2c_driver = {
 };
 module_i2c_driver(max20411_i2c_driver);
 
+MODULE_DESCRIPTION("Maxim MAX20411 High-Efficiency Single Step-Down Converter driver");
 MODULE_LICENSE("GPL");
diff --git a/drivers/regulator/mtk-dvfsrc-regulator.c b/drivers/regulator/mtk-dvfsrc-regulator.c
index f1280d45265d..1941aad5e247 100644
--- a/drivers/regulator/mtk-dvfsrc-regulator.c
+++ b/drivers/regulator/mtk-dvfsrc-regulator.c
@@ -211,4 +211,5 @@  static void __exit mtk_dvfsrc_regulator_exit(void)
 module_exit(mtk_dvfsrc_regulator_exit);
 
 MODULE_AUTHOR("Arvin wang <arvin.wang@mediatek.com>");
+MODULE_DESCRIPTION("MediaTek DVFSRC regulator driver");
 MODULE_LICENSE("GPL v2");
diff --git a/drivers/regulator/rt4831-regulator.c b/drivers/regulator/rt4831-regulator.c
index 97e6f7e2a0ba..7d1ba0c82271 100644
--- a/drivers/regulator/rt4831-regulator.c
+++ b/drivers/regulator/rt4831-regulator.c
@@ -202,4 +202,5 @@  static struct platform_driver rt4831_regulator_driver = {
 module_platform_driver(rt4831_regulator_driver);
 
 MODULE_AUTHOR("ChiYuan Huang <cy_huang@richtek.com>");
+MODULE_DESCRIPTION("Richtek RT4831 DSV RegulatorsRichtek RT4831 DSV Regulators driver");
 MODULE_LICENSE("GPL v2");
diff --git a/drivers/regulator/tps6286x-regulator.c b/drivers/regulator/tps6286x-regulator.c
index 758c70269653..65d0a5a145bd 100644
--- a/drivers/regulator/tps6286x-regulator.c
+++ b/drivers/regulator/tps6286x-regulator.c
@@ -156,4 +156,5 @@  static struct i2c_driver tps6286x_regulator_driver = {
 
 module_i2c_driver(tps6286x_regulator_driver);
 
+MODULE_DESCRIPTION("TI TPS6286x Power Regulator driver");
 MODULE_LICENSE("GPL v2");