| Message ID | 20240603-md-snd-soc-qcom-sdw-v1-1-101ea8bcdd38@quicinc.com (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 65909a7e7aa8b25c9cc5f04c1fd5d6f0f1d76fcd |
| Headers | show |
| Series | ASoC: qcom: add missing MODULE_DESCRIPTION() macro | expand |
On Mon, Jun 03, 2024 at 05:16:07PM -0700, Jeff Johnson wrote: > make allmodconfig && make W=1 C=1 reports: > WARNING: modpost: missing MODULE_DESCRIPTION() in sound/soc/qcom/snd-soc-qcom-sdw.o Is anyone getting any value from these MODULE_DESCRIPTION()s? This all just seems like a huge amount of noise and I'm having trouble thinking of a use case.
On 6/4/2024 4:56 AM, Mark Brown wrote: > On Mon, Jun 03, 2024 at 05:16:07PM -0700, Jeff Johnson wrote: >> make allmodconfig && make W=1 C=1 reports: >> WARNING: modpost: missing MODULE_DESCRIPTION() in sound/soc/qcom/snd-soc-qcom-sdw.o > > Is anyone getting any value from these MODULE_DESCRIPTION()s? This all > just seems like a huge amount of noise and I'm having trouble thinking > of a use case. https://bugzilla.kernel.org/show_bug.cgi?id=10770
On Tue, Jun 04, 2024 at 06:59:31AM -0700, Jeff Johnson wrote: > On 6/4/2024 4:56 AM, Mark Brown wrote: > > Is anyone getting any value from these MODULE_DESCRIPTION()s? This all > > just seems like a huge amount of noise and I'm having trouble thinking > > of a use case. > https://bugzilla.kernel.org/show_bug.cgi?id=10770 Please include human readable descriptions of things like commits and issues being discussed in e-mail in your mails, this makes them much easier for humans to read especially when they have no internet access. I do frequently catch up on my mail on flights or while otherwise travelling so this is even more pressing for me than just being about making things a bit easier to read. and I'm not seeing anything in the above link that articulates an actual use case.
On Tue, Jun 04, 2024 at 12:56:09PM +0100, Mark Brown wrote: > On Mon, Jun 03, 2024 at 05:16:07PM -0700, Jeff Johnson wrote: > > make allmodconfig && make W=1 C=1 reports: > > WARNING: modpost: missing MODULE_DESCRIPTION() in sound/soc/qcom/snd-soc-qcom-sdw.o > > Is anyone getting any value from these MODULE_DESCRIPTION()s? This all > just seems like a huge amount of noise and I'm having trouble thinking > of a use case. The missing MODULE_DESCRIPTION() warnings are very annoying. We recently missed a link error issue because the warning was drowned out in MODULE_DESCRIPTION() warnings. https://lore.kernel.org/all/202405182038.ncf1mL7Z-lkp@intel.com/ regards, dan carpenter
On Tue, Jun 04, 2024 at 05:46:14PM +0300, Dan Carpenter wrote: > On Tue, Jun 04, 2024 at 12:56:09PM +0100, Mark Brown wrote: > > Is anyone getting any value from these MODULE_DESCRIPTION()s? This all > > just seems like a huge amount of noise and I'm having trouble thinking > > of a use case. > The missing MODULE_DESCRIPTION() warnings are very annoying. We > recently missed a link error issue because the warning was drowned out > in MODULE_DESCRIPTION() warnings. > https://lore.kernel.org/all/202405182038.ncf1mL7Z-lkp@intel.com/ Yeah, adding the warning seems premature without having first added the descriptions and I'm not clear in what situation anyone would actually care given how rare it is for someone to manually interact with module loading. The number of cases where anyone would not just look at the source seems vanishingly small.
On Mon, 03 Jun 2024 17:16:07 -0700, Jeff Johnson wrote: > make allmodconfig && make W=1 C=1 reports: > WARNING: modpost: missing MODULE_DESCRIPTION() in sound/soc/qcom/snd-soc-qcom-sdw.o > > Add the missing invocation of the MODULE_DESCRIPTION() macro. > > Applied to https://git.kernel.org/pub/scm/linux/kernel/git/broonie/sound.git for-next Thanks! [1/1] ASoC: qcom: add missing MODULE_DESCRIPTION() macro commit: 65909a7e7aa8b25c9cc5f04c1fd5d6f0f1d76fcd 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
On 2024-06-04 13:56, Mark Brown wrote: > On Mon, Jun 03, 2024 at 05:16:07PM -0700, Jeff Johnson wrote: >> make allmodconfig && make W=1 C=1 reports: >> WARNING: modpost: missing MODULE_DESCRIPTION() in >> sound/soc/qcom/snd-soc-qcom-sdw.o > > Is anyone getting any value from these MODULE_DESCRIPTION()s? This all > just seems like a huge amount of noise and I'm having trouble thinking > of a use case. FWIW, I find module descriptions useful. Of course, there are some of them that don't provide much value, but the well-written ones are good.
On 6/4/2024 7:14 AM, Mark Brown wrote: > On Tue, Jun 04, 2024 at 06:59:31AM -0700, Jeff Johnson wrote: >> On 6/4/2024 4:56 AM, Mark Brown wrote: > >>> Is anyone getting any value from these MODULE_DESCRIPTION()s? This all >>> just seems like a huge amount of noise and I'm having trouble thinking >>> of a use case. > >> https://bugzilla.kernel.org/show_bug.cgi?id=10770 > > Please include human readable descriptions of things like commits and > issues being discussed in e-mail in your mails, this makes them much > easier for humans to read especially when they have no internet access. > I do frequently catch up on my mail on flights or while otherwise > travelling so this is even more pressing for me than just being about > making things a bit easier to read. > > and I'm not seeing anything in the above link that articulates an actual > use case. Sorry for the terse response. I agree with others that it was premature to enable the warnings before all the instances were cleaned. But since things are as they are, and since I saw others had 100% cleaned drivers/net, I took it upon myself to clean up some other top-level directories without worrying about if it made sense or not. /jeff
diff --git a/sound/soc/qcom/sdw.c b/sound/soc/qcom/sdw.c index eaa8bb016e50..f2eda2ff46c0 100644 --- a/sound/soc/qcom/sdw.c +++ b/sound/soc/qcom/sdw.c @@ -160,4 +160,5 @@ int qcom_snd_sdw_hw_free(struct snd_pcm_substream *substream, return 0; } EXPORT_SYMBOL_GPL(qcom_snd_sdw_hw_free); +MODULE_DESCRIPTION("Qualcomm ASoC SoundWire helper functions"); MODULE_LICENSE("GPL");
make allmodconfig && make W=1 C=1 reports: WARNING: modpost: missing MODULE_DESCRIPTION() in sound/soc/qcom/snd-soc-qcom-sdw.o Add the missing invocation of the MODULE_DESCRIPTION() macro. Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com> --- sound/soc/qcom/sdw.c | 1 + 1 file changed, 1 insertion(+) --- base-commit: 83814698cf48ce3aadc5d88a3f577f04482ff92a change-id: 20240602-md-snd-soc-qcom-sdw-07dac5b62d65