2022-04-27 09:49:51

by Bagas Sanjaya

[permalink] [raw]
Subject: [PATCH] KVM: powerpc: remove extraneous asterisk from rm_host_ipi_action comment

kernel test robot reported kernel-doc warning for rm_host_ipi_action():

arch/powerpc/kvm/book3s_hv_rm_xics.c:887: warning: This comment
starts with '/**', but isn't a kernel-doc comment. Refer
Documentation/doc-guide/kernel-doc.rst

Since the function is static, remove the extraneous (second) asterisk at
the head of function comment.

Link: https://lore.kernel.org/linux-doc/[email protected]/
Reported-by: kernel test robot <[email protected]>
Cc: Suresh Warrier <[email protected]>
Cc: Paul Mackerras <[email protected]>
Cc: Anders Roxell <[email protected]>
Cc: Greg Kroah-Hartman <[email protected]>
Cc: Arnd Bergmann <[email protected]>
Cc: Segher Boessenkool <[email protected]>
Cc: Michael Ellerman <[email protected]>
Cc: Benjamin Herrenschmidt <[email protected]>
Cc: Nicholas Piggin <[email protected]>
Cc: Fabiano Rosas <[email protected]>
Cc: Paolo Bonzini <[email protected]>
Cc: Alexey Kardashevskiy <[email protected]>
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Cc: [email protected]
Signed-off-by: Bagas Sanjaya <[email protected]>
---
arch/powerpc/kvm/book3s_hv_rm_xics.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/arch/powerpc/kvm/book3s_hv_rm_xics.c b/arch/powerpc/kvm/book3s_hv_rm_xics.c
index 587c33fc45640f..6e16bd751c8423 100644
--- a/arch/powerpc/kvm/book3s_hv_rm_xics.c
+++ b/arch/powerpc/kvm/book3s_hv_rm_xics.c
@@ -883,7 +883,7 @@ long kvmppc_deliver_irq_passthru(struct kvm_vcpu *vcpu,

/* --- Non-real mode XICS-related built-in routines --- */

-/**
+/*
* Host Operations poked by RM KVM
*/
static void rm_host_ipi_action(int action, void *data)

base-commit: d615b5416f8a1afeb82d13b238f8152c572d59c0
--
An old man doll... just what I always wanted! - Clara


2022-04-27 10:09:43

by Segher Boessenkool

[permalink] [raw]
Subject: Re: [PATCH] KVM: powerpc: remove extraneous asterisk from rm_host_ipi_action comment

On Tue, Apr 26, 2022 at 02:47:51PM +0700, Bagas Sanjaya wrote:
> kernel test robot reported kernel-doc warning for rm_host_ipi_action():
>
> arch/powerpc/kvm/book3s_hv_rm_xics.c:887: warning: This comment
> starts with '/**', but isn't a kernel-doc comment. Refer
> Documentation/doc-guide/kernel-doc.rst
>
> Since the function is static, remove the extraneous (second) asterisk at
> the head of function comment.
>
> Link: https://lore.kernel.org/linux-doc/[email protected]/
> Reported-by: kernel test robot <[email protected]>
> Cc: Suresh Warrier <[email protected]>
> Cc: Paul Mackerras <[email protected]>
> Cc: Anders Roxell <[email protected]>
> Cc: Greg Kroah-Hartman <[email protected]>
> Cc: Arnd Bergmann <[email protected]>
> Cc: Segher Boessenkool <[email protected]>

Please do not Cc: me on random patches, I get enough mail already :-)


Segher