diff mbox series

xen: add missing MODULE_DESCRIPTION() macros

Message ID 20240611-md-drivers-xen-v1-1-1eb677364ca6@quicinc.com (mailing list archive)
State Accepted
Commit 7cd23c1817b8f9df61dac67848d9593b1ca8882f
Headers show
Series xen: add missing MODULE_DESCRIPTION() macros | expand

Commit Message

Jeff Johnson June 11, 2024, 11:54 p.m. UTC 
With ARCH=x86, make allmodconfig && make W=1 C=1 reports:
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/xen/xen-pciback/xen-pciback.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/xen/xen-evtchn.o
WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/xen/xen-privcmd.o

Add the missing invocations of the MODULE_DESCRIPTION() macro.

Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
---
Corrections to these descriptions are welcomed. I'm not an expert in
this code so in most cases I've taken these descriptions directly from
code comments, Kconfig descriptions, or git logs.  History has shown
that in some cases these are originally wrong due to cut-n-paste
errors, and in other cases the drivers have evolved such that the
original information is no longer accurate.
---
 drivers/xen/evtchn.c               | 1 +
 drivers/xen/privcmd-buf.c          | 1 +
 drivers/xen/privcmd.c              | 1 +
 drivers/xen/xen-pciback/pci_stub.c | 1 +
 4 files changed, 4 insertions(+)


---
base-commit: 83a7eefedc9b56fe7bfeff13b6c7356688ffa670
change-id: 20240611-md-drivers-xen-522fc8e7ef08

Comments

Jeff Johnson June 26, 2024, 4:46 p.m. UTC | #1 
On 6/11/2024 4:54 PM, Jeff Johnson wrote:
> With ARCH=x86, make allmodconfig && make W=1 C=1 reports:
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/xen/xen-pciback/xen-pciback.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/xen/xen-evtchn.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/xen/xen-privcmd.o
> 
> Add the missing invocations of the MODULE_DESCRIPTION() macro.
> 
> Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
> ---
> Corrections to these descriptions are welcomed. I'm not an expert in
> this code so in most cases I've taken these descriptions directly from
> code comments, Kconfig descriptions, or git logs.  History has shown
> that in some cases these are originally wrong due to cut-n-paste
> errors, and in other cases the drivers have evolved such that the
> original information is no longer accurate.
> ---
>  drivers/xen/evtchn.c               | 1 +
>  drivers/xen/privcmd-buf.c          | 1 +
>  drivers/xen/privcmd.c              | 1 +
>  drivers/xen/xen-pciback/pci_stub.c | 1 +
>  4 files changed, 4 insertions(+)
> 
> diff --git a/drivers/xen/evtchn.c b/drivers/xen/evtchn.c
> index f6a2216c2c87..9b7fcc7dbb38 100644
> --- a/drivers/xen/evtchn.c
> +++ b/drivers/xen/evtchn.c
> @@ -729,4 +729,5 @@ static void __exit evtchn_cleanup(void)
>  module_init(evtchn_init);
>  module_exit(evtchn_cleanup);
>  
> +MODULE_DESCRIPTION("Xen /dev/xen/evtchn device driver");
>  MODULE_LICENSE("GPL");
> diff --git a/drivers/xen/privcmd-buf.c b/drivers/xen/privcmd-buf.c
> index 2fa10ca5be14..0f0dad427d7e 100644
> --- a/drivers/xen/privcmd-buf.c
> +++ b/drivers/xen/privcmd-buf.c
> @@ -19,6 +19,7 @@
>  
>  #include "privcmd.h"
>  
> +MODULE_DESCRIPTION("Xen Mmap of hypercall buffers");
>  MODULE_LICENSE("GPL");
>  
>  struct privcmd_buf_private {
> diff --git a/drivers/xen/privcmd.c b/drivers/xen/privcmd.c
> index 67dfa4778864..b9b784633c01 100644
> --- a/drivers/xen/privcmd.c
> +++ b/drivers/xen/privcmd.c
> @@ -48,6 +48,7 @@
>  
>  #include "privcmd.h"
>  
> +MODULE_DESCRIPTION("Xen hypercall passthrough driver");
>  MODULE_LICENSE("GPL");
>  
>  #define PRIV_VMA_LOCKED ((void *)1)
> diff --git a/drivers/xen/xen-pciback/pci_stub.c b/drivers/xen/xen-pciback/pci_stub.c
> index e34b623e4b41..4faebbb84999 100644
> --- a/drivers/xen/xen-pciback/pci_stub.c
> +++ b/drivers/xen/xen-pciback/pci_stub.c
> @@ -1708,5 +1708,6 @@ static void __exit xen_pcibk_cleanup(void)
>  module_init(xen_pcibk_init);
>  module_exit(xen_pcibk_cleanup);
>  
> +MODULE_DESCRIPTION("Xen PCI-device stub driver");
>  MODULE_LICENSE("Dual BSD/GPL");
>  MODULE_ALIAS("xen-backend:pci");
> 
> ---
> base-commit: 83a7eefedc9b56fe7bfeff13b6c7356688ffa670
> change-id: 20240611-md-drivers-xen-522fc8e7ef08
> 

Following up to see if anything else is needed from me. Hoping to see this in
linux-next so I can remove it from my tracking spreadsheet :)

/jeff
Jürgen Groß July 2, 2024, 7:27 a.m. UTC | #2 
On 12.06.24 01:54, Jeff Johnson wrote:
> With ARCH=x86, make allmodconfig && make W=1 C=1 reports:
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/xen/xen-pciback/xen-pciback.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/xen/xen-evtchn.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/xen/xen-privcmd.o
> 
> Add the missing invocations of the MODULE_DESCRIPTION() macro.
> 
> Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>

Reviewed-by: Juergen Gross <jgross@suse.com>


Juergen
Jürgen Groß July 2, 2024, 9:20 a.m. UTC | #3 
On 26.06.24 18:46, Jeff Johnson wrote:
> On 6/11/2024 4:54 PM, Jeff Johnson wrote:
>> With ARCH=x86, make allmodconfig && make W=1 C=1 reports:
>> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/xen/xen-pciback/xen-pciback.o
>> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/xen/xen-evtchn.o
>> WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/xen/xen-privcmd.o
>>
>> Add the missing invocations of the MODULE_DESCRIPTION() macro.
>>
>> Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
>> ---
>> Corrections to these descriptions are welcomed. I'm not an expert in
>> this code so in most cases I've taken these descriptions directly from
>> code comments, Kconfig descriptions, or git logs.  History has shown
>> that in some cases these are originally wrong due to cut-n-paste
>> errors, and in other cases the drivers have evolved such that the
>> original information is no longer accurate.
>> ---
>>   drivers/xen/evtchn.c               | 1 +
>>   drivers/xen/privcmd-buf.c          | 1 +
>>   drivers/xen/privcmd.c              | 1 +
>>   drivers/xen/xen-pciback/pci_stub.c | 1 +
>>   4 files changed, 4 insertions(+)
>>
>> diff --git a/drivers/xen/evtchn.c b/drivers/xen/evtchn.c
>> index f6a2216c2c87..9b7fcc7dbb38 100644
>> --- a/drivers/xen/evtchn.c
>> +++ b/drivers/xen/evtchn.c
>> @@ -729,4 +729,5 @@ static void __exit evtchn_cleanup(void)
>>   module_init(evtchn_init);
>>   module_exit(evtchn_cleanup);
>>   
>> +MODULE_DESCRIPTION("Xen /dev/xen/evtchn device driver");
>>   MODULE_LICENSE("GPL");
>> diff --git a/drivers/xen/privcmd-buf.c b/drivers/xen/privcmd-buf.c
>> index 2fa10ca5be14..0f0dad427d7e 100644
>> --- a/drivers/xen/privcmd-buf.c
>> +++ b/drivers/xen/privcmd-buf.c
>> @@ -19,6 +19,7 @@
>>   
>>   #include "privcmd.h"
>>   
>> +MODULE_DESCRIPTION("Xen Mmap of hypercall buffers");
>>   MODULE_LICENSE("GPL");
>>   
>>   struct privcmd_buf_private {
>> diff --git a/drivers/xen/privcmd.c b/drivers/xen/privcmd.c
>> index 67dfa4778864..b9b784633c01 100644
>> --- a/drivers/xen/privcmd.c
>> +++ b/drivers/xen/privcmd.c
>> @@ -48,6 +48,7 @@
>>   
>>   #include "privcmd.h"
>>   
>> +MODULE_DESCRIPTION("Xen hypercall passthrough driver");
>>   MODULE_LICENSE("GPL");
>>   
>>   #define PRIV_VMA_LOCKED ((void *)1)
>> diff --git a/drivers/xen/xen-pciback/pci_stub.c b/drivers/xen/xen-pciback/pci_stub.c
>> index e34b623e4b41..4faebbb84999 100644
>> --- a/drivers/xen/xen-pciback/pci_stub.c
>> +++ b/drivers/xen/xen-pciback/pci_stub.c
>> @@ -1708,5 +1708,6 @@ static void __exit xen_pcibk_cleanup(void)
>>   module_init(xen_pcibk_init);
>>   module_exit(xen_pcibk_cleanup);
>>   
>> +MODULE_DESCRIPTION("Xen PCI-device stub driver");
>>   MODULE_LICENSE("Dual BSD/GPL");
>>   MODULE_ALIAS("xen-backend:pci");
>>
>> ---
>> base-commit: 83a7eefedc9b56fe7bfeff13b6c7356688ffa670
>> change-id: 20240611-md-drivers-xen-522fc8e7ef08
>>
> 
> Following up to see if anything else is needed from me. Hoping to see this in
> linux-next so I can remove it from my tracking spreadsheet :)

I've pushed the patch to the xen/tip.git for-next branch.


Juergen
diff mbox series

Patch

diff --git a/drivers/xen/evtchn.c b/drivers/xen/evtchn.c
index f6a2216c2c87..9b7fcc7dbb38 100644
--- a/drivers/xen/evtchn.c
+++ b/drivers/xen/evtchn.c
@@ -729,4 +729,5 @@  static void __exit evtchn_cleanup(void)
 module_init(evtchn_init);
 module_exit(evtchn_cleanup);
 
+MODULE_DESCRIPTION("Xen /dev/xen/evtchn device driver");
 MODULE_LICENSE("GPL");
diff --git a/drivers/xen/privcmd-buf.c b/drivers/xen/privcmd-buf.c
index 2fa10ca5be14..0f0dad427d7e 100644
--- a/drivers/xen/privcmd-buf.c
+++ b/drivers/xen/privcmd-buf.c
@@ -19,6 +19,7 @@ 
 
 #include "privcmd.h"
 
+MODULE_DESCRIPTION("Xen Mmap of hypercall buffers");
 MODULE_LICENSE("GPL");
 
 struct privcmd_buf_private {
diff --git a/drivers/xen/privcmd.c b/drivers/xen/privcmd.c
index 67dfa4778864..b9b784633c01 100644
--- a/drivers/xen/privcmd.c
+++ b/drivers/xen/privcmd.c
@@ -48,6 +48,7 @@ 
 
 #include "privcmd.h"
 
+MODULE_DESCRIPTION("Xen hypercall passthrough driver");
 MODULE_LICENSE("GPL");
 
 #define PRIV_VMA_LOCKED ((void *)1)
diff --git a/drivers/xen/xen-pciback/pci_stub.c b/drivers/xen/xen-pciback/pci_stub.c
index e34b623e4b41..4faebbb84999 100644
--- a/drivers/xen/xen-pciback/pci_stub.c
+++ b/drivers/xen/xen-pciback/pci_stub.c
@@ -1708,5 +1708,6 @@  static void __exit xen_pcibk_cleanup(void)
 module_init(xen_pcibk_init);
 module_exit(xen_pcibk_cleanup);
 
+MODULE_DESCRIPTION("Xen PCI-device stub driver");
 MODULE_LICENSE("Dual BSD/GPL");
 MODULE_ALIAS("xen-backend:pci");