[PATCH] arm64: kvm/hyp/nvhe: fix a non-kernel-doc comment

[PATCH] arm64: kvm/hyp/nvhe: fix a non-kernel-doc comment

[Randy Dunlap]

Do not use kernel-doc "/**" notation when the comment is not in
kernel-doc format.

Fixes this docs build warning:

arch/arm64/kvm/hyp/nvhe/sys_regs.c:478: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
    * Handler for protected VM restricted exceptions.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Reported-by: kernel test robot <lkp@intel.com>
Cc: Fuad Tabba <tabba@google.com>
Cc: Marc Zyngier <maz@kernel.org>
Cc: linux-arm-kernel@lists.infradead.org
Cc: kvmarm@lists.cs.columbia.edu
---
 arch/arm64/kvm/hyp/nvhe/sys_regs.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--- linux-next-20211106.orig/arch/arm64/kvm/hyp/nvhe/sys_regs.c
+++ linux-next-20211106/arch/arm64/kvm/hyp/nvhe/sys_regs.c
@@ -474,7 +474,7 @@ bool kvm_handle_pvm_sysreg(struct kvm_vc
 	return true;
 }
 
-/**
+/*
  * Handler for protected VM restricted exceptions.
  *
  * Inject an undefined exception into the guest and return true to indicate that

Re: [PATCH] arm64: kvm/hyp/nvhe: fix a non-kernel-doc comment

[Marc Zyngier]

On Fri, 5 Nov 2021 20:25:29 -0700, Randy Dunlap wrote:
> Do not use kernel-doc "/**" notation when the comment is not in
> kernel-doc format.
> 
> Fixes this docs build warning:
> 
> arch/arm64/kvm/hyp/nvhe/sys_regs.c:478: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>     * Handler for protected VM restricted exceptions.

Applied to next, thanks!

[1/1] arm64: kvm/hyp/nvhe: fix a non-kernel-doc comment
      commit: deacd669e18a51cb2085450c56d851aef72b3256

Cheers,

	M.
-- 
Without deviation from the norm, progress is not possible.