KVM: arm64: debug: fix kernel-doc warnings
authorRandy Dunlap <rdunlap@infradead.org>
Wed, 17 Jan 2024 23:07:05 +0000 (15:07 -0800)
committerOliver Upton <oliver.upton@linux.dev>
Thu, 1 Feb 2024 20:25:41 +0000 (20:25 +0000)
commitc4d15f841570dafc079966baa8fd1bc31cd5bf36
tree291c4a39a5fe53748be15c333a765601fee8bb6a
parent6613476e225e090cc9aad49be7fa504e290dd33d
KVM: arm64: debug: fix kernel-doc warnings

Change one "/**" comment to a common "/*" comment since the comment
is not in kernel-doc format.
Add description for the @vcpu function parameter.

These changes prevent warnings:

debug.c:27: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * save/restore_guest_debug_regs
debug.c:27: warning: missing initial short description on line:
 * save/restore_guest_debug_regs
debug.c:149: warning: Function parameter or struct member 'vcpu' not described in 'kvm_arm_reset_debug_ptr'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Marc Zyngier <maz@kernel.org>
Cc: Oliver Upton <oliver.upton@linux.dev>
Cc: James Morse <james.morse@arm.com>
Cc: Suzuki K Poulose <suzuki.poulose@arm.com>
Cc: Zenghui Yu <yuzenghui@huawei.com>
Cc: linux-arm-kernel@lists.infradead.org
Cc: kvmarm@lists.linux.dev
Cc: Catalin Marinas <catalin.marinas@arm.com>
Cc: Will Deacon <will@kernel.org>
Reviewed-by: Suzuki K Poulose <suzuki.poulose@arm.com>
Reviewed-by: Zenghui Yu <yuzenghui@huawei.com>
Link: https://lore.kernel.org/r/20240117230714.31025-2-rdunlap@infradead.org
Signed-off-by: Oliver Upton <oliver.upton@linux.dev>
arch/arm64/kvm/debug.c