Skip to content

Commit c4d15f8

Browse files
rddunlapoupton
authored andcommitted
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>
1 parent 6613476 commit c4d15f8

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

arch/arm64/kvm/debug.c

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
static DEFINE_PER_CPU(u64, mdcr_el2);
2525

26-
/**
26+
/*
2727
* save/restore_guest_debug_regs
2828
*
2929
* For some debug operations we need to tweak some guest registers. As
@@ -143,6 +143,7 @@ void kvm_arm_vcpu_init_debug(struct kvm_vcpu *vcpu)
143143

144144
/**
145145
* kvm_arm_reset_debug_ptr - reset the debug ptr to point to the vcpu state
146+
* @vcpu: the vcpu pointer
146147
*/
147148

148149
void kvm_arm_reset_debug_ptr(struct kvm_vcpu *vcpu)

0 commit comments

Comments
 (0)