kfifo: add missing MODULE_DESCRIPTION() macros

[PATCH] kfifo: add missing MODULE_DESCRIPTION() macros

Posted by Jeff Johnson 1 year, 8 months ago

make allmodconfig && make W=1 C=1 reports:
WARNING: modpost: missing MODULE_DESCRIPTION() in samples/kfifo/bytestream-example.o
WARNING: modpost: missing MODULE_DESCRIPTION() in samples/kfifo/dma-example.o
WARNING: modpost: missing MODULE_DESCRIPTION() in samples/kfifo/inttype-example.o
WARNING: modpost: missing MODULE_DESCRIPTION() in samples/kfifo/record-example.o

Add the missing invocations of the MODULE_DESCRIPTION() macro.

Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
---
 samples/kfifo/bytestream-example.c | 1 +
 samples/kfifo/dma-example.c        | 1 +
 samples/kfifo/inttype-example.c    | 1 +
 samples/kfifo/record-example.c     | 1 +
 4 files changed, 4 insertions(+)

diff --git a/samples/kfifo/bytestream-example.c b/samples/kfifo/bytestream-example.c
index 642d0748c169..4ae29a12cc8a 100644
--- a/samples/kfifo/bytestream-example.c
+++ b/samples/kfifo/bytestream-example.c
@@ -191,5 +191,6 @@ static void __exit example_exit(void)
 
 module_init(example_init);
 module_exit(example_exit);
+MODULE_DESCRIPTION("Sample kfifo byte stream implementation");
 MODULE_LICENSE("GPL");
 MODULE_AUTHOR("Stefani Seibold <stefani@seibold.net>");
diff --git a/samples/kfifo/dma-example.c b/samples/kfifo/dma-example.c
index 74fe915b7ffe..48df719dac8c 100644
--- a/samples/kfifo/dma-example.c
+++ b/samples/kfifo/dma-example.c
@@ -138,5 +138,6 @@ static void __exit example_exit(void)
 
 module_init(example_init);
 module_exit(example_exit);
+MODULE_DESCRIPTION("Sample fifo dma implementation");
 MODULE_LICENSE("GPL");
 MODULE_AUTHOR("Stefani Seibold <stefani@seibold.net>");
diff --git a/samples/kfifo/inttype-example.c b/samples/kfifo/inttype-example.c
index c61482ba94f4..e4f93317c5d0 100644
--- a/samples/kfifo/inttype-example.c
+++ b/samples/kfifo/inttype-example.c
@@ -182,5 +182,6 @@ static void __exit example_exit(void)
 
 module_init(example_init);
 module_exit(example_exit);
+MODULE_DESCRIPTION("Sample kfifo int type implementation");
 MODULE_LICENSE("GPL");
 MODULE_AUTHOR("Stefani Seibold <stefani@seibold.net>");
diff --git a/samples/kfifo/record-example.c b/samples/kfifo/record-example.c
index e4087b2d3fc4..e4d1a2d7983c 100644
--- a/samples/kfifo/record-example.c
+++ b/samples/kfifo/record-example.c
@@ -198,5 +198,6 @@ static void __exit example_exit(void)
 
 module_init(example_init);
 module_exit(example_exit);
+MODULE_DESCRIPTION("Sample dynamic sized record fifo implementation");
 MODULE_LICENSE("GPL");
 MODULE_AUTHOR("Stefani Seibold <stefani@seibold.net>");

---
base-commit: b050496579632f86ee1ef7e7501906db579f3457
change-id: 20240601-md-samples-kfifo-40ba0aa7042f

Re: [PATCH] kfifo: add missing MODULE_DESCRIPTION() macros

Posted by Jeff Johnson 1 year, 7 months ago

On 6/1/2024 5:50 PM, Jeff Johnson wrote:
> make allmodconfig && make W=1 C=1 reports:
> WARNING: modpost: missing MODULE_DESCRIPTION() in samples/kfifo/bytestream-example.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in samples/kfifo/dma-example.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in samples/kfifo/inttype-example.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in samples/kfifo/record-example.o
> 
> Add the missing invocations of the MODULE_DESCRIPTION() macro.
> 
> Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
> ---
>  samples/kfifo/bytestream-example.c | 1 +
>  samples/kfifo/dma-example.c        | 1 +
>  samples/kfifo/inttype-example.c    | 1 +
>  samples/kfifo/record-example.c     | 1 +
>  4 files changed, 4 insertions(+)
> 
> diff --git a/samples/kfifo/bytestream-example.c b/samples/kfifo/bytestream-example.c
> index 642d0748c169..4ae29a12cc8a 100644
> --- a/samples/kfifo/bytestream-example.c
> +++ b/samples/kfifo/bytestream-example.c
> @@ -191,5 +191,6 @@ static void __exit example_exit(void)
>  
>  module_init(example_init);
>  module_exit(example_exit);
> +MODULE_DESCRIPTION("Sample kfifo byte stream implementation");
>  MODULE_LICENSE("GPL");
>  MODULE_AUTHOR("Stefani Seibold <stefani@seibold.net>");
> diff --git a/samples/kfifo/dma-example.c b/samples/kfifo/dma-example.c
> index 74fe915b7ffe..48df719dac8c 100644
> --- a/samples/kfifo/dma-example.c
> +++ b/samples/kfifo/dma-example.c
> @@ -138,5 +138,6 @@ static void __exit example_exit(void)
>  
>  module_init(example_init);
>  module_exit(example_exit);
> +MODULE_DESCRIPTION("Sample fifo dma implementation");
>  MODULE_LICENSE("GPL");
>  MODULE_AUTHOR("Stefani Seibold <stefani@seibold.net>");
> diff --git a/samples/kfifo/inttype-example.c b/samples/kfifo/inttype-example.c
> index c61482ba94f4..e4f93317c5d0 100644
> --- a/samples/kfifo/inttype-example.c
> +++ b/samples/kfifo/inttype-example.c
> @@ -182,5 +182,6 @@ static void __exit example_exit(void)
>  
>  module_init(example_init);
>  module_exit(example_exit);
> +MODULE_DESCRIPTION("Sample kfifo int type implementation");
>  MODULE_LICENSE("GPL");
>  MODULE_AUTHOR("Stefani Seibold <stefani@seibold.net>");
> diff --git a/samples/kfifo/record-example.c b/samples/kfifo/record-example.c
> index e4087b2d3fc4..e4d1a2d7983c 100644
> --- a/samples/kfifo/record-example.c
> +++ b/samples/kfifo/record-example.c
> @@ -198,5 +198,6 @@ static void __exit example_exit(void)
>  
>  module_init(example_init);
>  module_exit(example_exit);
> +MODULE_DESCRIPTION("Sample dynamic sized record fifo implementation");
>  MODULE_LICENSE("GPL");
>  MODULE_AUTHOR("Stefani Seibold <stefani@seibold.net>");
> 
> ---
> base-commit: b050496579632f86ee1ef7e7501906db579f3457
> change-id: 20240601-md-samples-kfifo-40ba0aa7042f
> 

I don't see this in linux-next yet so following up to see if anything else is
needed to get this merged.

Adding Andrew & Greg since they've signed off on these files in the past

/jeff