2024-06-12 14:48:09

by Jeff Johnson

[permalink] [raw]
Subject: [PATCH] media: videobuf2: add missing MODULE_DESCRIPTION() macro

With ARCH=x86, make allmodconfig && make W=1 C=1 reports:
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/media/common/videobuf2/videobuf2-dvb.o

Add the missing invocation of the MODULE_DESCRIPTION() macro.

Signed-off-by: Jeff Johnson <[email protected]>
---
While doing these cleanups, in most cases I've taken the descriptions
directly from code comments, Kconfig descriptions, or git logs, but in
this case I didn't see a nice concise description so I invented this
one. Please suggest a replacement if this isn't an appropriate
description.
---
drivers/media/common/videobuf2/videobuf2-dvb.c | 1 +
1 file changed, 1 insertion(+)

diff --git a/drivers/media/common/videobuf2/videobuf2-dvb.c b/drivers/media/common/videobuf2/videobuf2-dvb.c
index 8c15bcd07eef..6f6650183184 100644
--- a/drivers/media/common/videobuf2/videobuf2-dvb.c
+++ b/drivers/media/common/videobuf2/videobuf2-dvb.c
@@ -19,6 +19,7 @@
/* ------------------------------------------------------------------ */

MODULE_AUTHOR("Gerd Knorr <[email protected]> [SuSE Labs]");
+MODULE_DESCRIPTION("Simple DVB helper framework for videobuf2");
MODULE_LICENSE("GPL");

/* ------------------------------------------------------------------ */

---
base-commit: 83a7eefedc9b56fe7bfeff13b6c7356688ffa670
change-id: 20240612-md-drivers-media-common-videobuf2-e3fb58676092



2024-06-13 02:28:24

by Tomasz Figa

[permalink] [raw]
Subject: Re: [PATCH] media: videobuf2: add missing MODULE_DESCRIPTION() macro

Hi Jeff,

On Wed, Jun 12, 2024 at 11:46 PM Jeff Johnson <[email protected]> wrote:
>
> With ARCH=x86, make allmodconfig && make W=1 C=1 reports:
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/media/common/videobuf2/videobuf2-dvb.o
>
> Add the missing invocation of the MODULE_DESCRIPTION() macro.
>
> Signed-off-by: Jeff Johnson <[email protected]>
> ---
> While doing these cleanups, in most cases I've taken the descriptions
> directly from code comments, Kconfig descriptions, or git logs, but in
> this case I didn't see a nice concise description so I invented this
> one. Please suggest a replacement if this isn't an appropriate
> description.
> ---
> drivers/media/common/videobuf2/videobuf2-dvb.c | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/drivers/media/common/videobuf2/videobuf2-dvb.c b/drivers/media/common/videobuf2/videobuf2-dvb.c
> index 8c15bcd07eef..6f6650183184 100644
> --- a/drivers/media/common/videobuf2/videobuf2-dvb.c
> +++ b/drivers/media/common/videobuf2/videobuf2-dvb.c
> @@ -19,6 +19,7 @@
> /* ------------------------------------------------------------------ */
>
> MODULE_AUTHOR("Gerd Knorr <[email protected]> [SuSE Labs]");
> +MODULE_DESCRIPTION("Simple DVB helper framework for videobuf2");

Thanks for the patch!

Looking at the header at the top of the file:

* some helper function for simple DVB cards which simply DMA the
* complete transport stream and let the computer sort everything else
* (i.e. we are using the software demux, ...). Also uses vb2
* to manage DMA buffers.

I think I'd call it "Videobuf2 helpers library for simple DVB cards".
But maybe we could have some DVB expert comment on this. :)

Regardless of whether the description stays or changes, feel free to add

Acked-by: Tomasz Figa <[email protected]>

Best regards,
Tomasz