diff mbox series

KVM: x86: add missing MODULE_DESCRIPTION() macros

Message ID 20240528-md-kvm-v1-1-c1b86f0f5112@quicinc.com (mailing list archive)
State New, archived
Headers show
Series KVM: x86: add missing MODULE_DESCRIPTION() macros | expand

Commit Message

Jeff Johnson May 28, 2024, 8:06 p.m. UTC 
Fix the following allmodconfig 'make W=1' warnings when building for x86:
WARNING: modpost: missing MODULE_DESCRIPTION() in arch/x86/kvm/kvm.o
WARNING: modpost: missing MODULE_DESCRIPTION() in arch/x86/kvm/kvm-intel.o
WARNING: modpost: missing MODULE_DESCRIPTION() in arch/x86/kvm/kvm-amd.o

Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
---
 arch/x86/kvm/svm/svm.c | 1 +
 arch/x86/kvm/vmx/vmx.c | 1 +
 virt/kvm/kvm_main.c    | 1 +
 3 files changed, 3 insertions(+)


---
base-commit: 2bfcfd584ff5ccc8bb7acde19b42570414bf880b
change-id: 20240528-md-kvm-36f20bc4a5b0

Comments

Sean Christopherson June 3, 2024, 11:09 p.m. UTC | #1 
On Tue, May 28, 2024, Jeff Johnson wrote:
> Fix the following allmodconfig 'make W=1' warnings when building for x86:
> WARNING: modpost: missing MODULE_DESCRIPTION() in arch/x86/kvm/kvm.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in arch/x86/kvm/kvm-intel.o
> WARNING: modpost: missing MODULE_DESCRIPTION() in arch/x86/kvm/kvm-amd.o
> 
> Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
> ---
>  arch/x86/kvm/svm/svm.c | 1 +
>  arch/x86/kvm/vmx/vmx.c | 1 +
>  virt/kvm/kvm_main.c    | 1 +
>  3 files changed, 3 insertions(+)
> 
> diff --git a/arch/x86/kvm/svm/svm.c b/arch/x86/kvm/svm/svm.c
> index c8dc25886c16..bdd39931720c 100644
> --- a/arch/x86/kvm/svm/svm.c
> +++ b/arch/x86/kvm/svm/svm.c
> @@ -53,6 +53,7 @@
>  #include "svm_onhyperv.h"
>  
>  MODULE_AUTHOR("Qumranet");
> +MODULE_DESCRIPTION("KVM SVM (AMD-V) extensions");

How about "KVM support for SVM (AMD-V) extensions"?

>  MODULE_LICENSE("GPL");
>  
>  #ifdef MODULE
> diff --git a/arch/x86/kvm/vmx/vmx.c b/arch/x86/kvm/vmx/vmx.c
> index 6051fad5945f..956e6062f311 100644
> --- a/arch/x86/kvm/vmx/vmx.c
> +++ b/arch/x86/kvm/vmx/vmx.c
> @@ -74,6 +74,7 @@
>  #include "posted_intr.h"
>  
>  MODULE_AUTHOR("Qumranet");
> +MODULE_DESCRIPTION("KVM VMX (Intel VT-x) extensions");

And then a similar thing here.

>  MODULE_LICENSE("GPL");
>  
>  #ifdef MODULE
> diff --git a/virt/kvm/kvm_main.c b/virt/kvm/kvm_main.c
> index 14841acb8b95..b03d06ca29c4 100644
> --- a/virt/kvm/kvm_main.c
> +++ b/virt/kvm/kvm_main.c
> @@ -74,6 +74,7 @@
>  #define ITOA_MAX_LEN 12
>  
>  MODULE_AUTHOR("Qumranet");
> +MODULE_DESCRIPTION("Kernel-based Virtual Machine driver for Linux");

Maybe "Kernel-based Virtual Machine (KVM) Hypervisor"?  I personally never think
of KVM as a "driver", though I know it's been called that in the past.  And having
"Hypervisor" in the name might help unfamiliar users.
Jeff Johnson June 3, 2024, 11:21 p.m. UTC | #2 
On 6/3/2024 4:09 PM, Sean Christopherson wrote:
> On Tue, May 28, 2024, Jeff Johnson wrote:
>> Fix the following allmodconfig 'make W=1' warnings when building for x86:
>> WARNING: modpost: missing MODULE_DESCRIPTION() in arch/x86/kvm/kvm.o
>> WARNING: modpost: missing MODULE_DESCRIPTION() in arch/x86/kvm/kvm-intel.o
>> WARNING: modpost: missing MODULE_DESCRIPTION() in arch/x86/kvm/kvm-amd.o
>>
>> Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
>> ---
>>  arch/x86/kvm/svm/svm.c | 1 +
>>  arch/x86/kvm/vmx/vmx.c | 1 +
>>  virt/kvm/kvm_main.c    | 1 +
>>  3 files changed, 3 insertions(+)
>>
>> diff --git a/arch/x86/kvm/svm/svm.c b/arch/x86/kvm/svm/svm.c
>> index c8dc25886c16..bdd39931720c 100644
>> --- a/arch/x86/kvm/svm/svm.c
>> +++ b/arch/x86/kvm/svm/svm.c
>> @@ -53,6 +53,7 @@
>>  #include "svm_onhyperv.h"
>>  
>>  MODULE_AUTHOR("Qumranet");
>> +MODULE_DESCRIPTION("KVM SVM (AMD-V) extensions");
> 
> How about "KVM support for SVM (AMD-V) extensions"?
> 
>>  MODULE_LICENSE("GPL");
>>  
>>  #ifdef MODULE
>> diff --git a/arch/x86/kvm/vmx/vmx.c b/arch/x86/kvm/vmx/vmx.c
>> index 6051fad5945f..956e6062f311 100644
>> --- a/arch/x86/kvm/vmx/vmx.c
>> +++ b/arch/x86/kvm/vmx/vmx.c
>> @@ -74,6 +74,7 @@
>>  #include "posted_intr.h"
>>  
>>  MODULE_AUTHOR("Qumranet");
>> +MODULE_DESCRIPTION("KVM VMX (Intel VT-x) extensions");
> 
> And then a similar thing here.
> 
>>  MODULE_LICENSE("GPL");
>>  
>>  #ifdef MODULE
>> diff --git a/virt/kvm/kvm_main.c b/virt/kvm/kvm_main.c
>> index 14841acb8b95..b03d06ca29c4 100644
>> --- a/virt/kvm/kvm_main.c
>> +++ b/virt/kvm/kvm_main.c
>> @@ -74,6 +74,7 @@
>>  #define ITOA_MAX_LEN 12
>>  
>>  MODULE_AUTHOR("Qumranet");
>> +MODULE_DESCRIPTION("Kernel-based Virtual Machine driver for Linux");
> 
> Maybe "Kernel-based Virtual Machine (KVM) Hypervisor"?  I personally never think
> of KVM as a "driver", though I know it's been called that in the past.  And having
> "Hypervisor" in the name might help unfamiliar users.

Thanks for the suggestions since my first past was just gleaned from existing
code headers and Kconfig help text. Will spin a v2 after waiting for any
further comments.

/jeff
diff mbox series

Patch

diff --git a/arch/x86/kvm/svm/svm.c b/arch/x86/kvm/svm/svm.c
index c8dc25886c16..bdd39931720c 100644
--- a/arch/x86/kvm/svm/svm.c
+++ b/arch/x86/kvm/svm/svm.c
@@ -53,6 +53,7 @@ 
 #include "svm_onhyperv.h"
 
 MODULE_AUTHOR("Qumranet");
+MODULE_DESCRIPTION("KVM SVM (AMD-V) extensions");
 MODULE_LICENSE("GPL");
 
 #ifdef MODULE
diff --git a/arch/x86/kvm/vmx/vmx.c b/arch/x86/kvm/vmx/vmx.c
index 6051fad5945f..956e6062f311 100644
--- a/arch/x86/kvm/vmx/vmx.c
+++ b/arch/x86/kvm/vmx/vmx.c
@@ -74,6 +74,7 @@ 
 #include "posted_intr.h"
 
 MODULE_AUTHOR("Qumranet");
+MODULE_DESCRIPTION("KVM VMX (Intel VT-x) extensions");
 MODULE_LICENSE("GPL");
 
 #ifdef MODULE
diff --git a/virt/kvm/kvm_main.c b/virt/kvm/kvm_main.c
index 14841acb8b95..b03d06ca29c4 100644
--- a/virt/kvm/kvm_main.c
+++ b/virt/kvm/kvm_main.c
@@ -74,6 +74,7 @@ 
 #define ITOA_MAX_LEN 12
 
 MODULE_AUTHOR("Qumranet");
+MODULE_DESCRIPTION("Kernel-based Virtual Machine driver for Linux");
 MODULE_LICENSE("GPL");
 
 /* Architectures should define their poll value according to the halt latency */