From: Randy Dunlap <rdunlap@infradead.org>
To: linux-kernel@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>,
Marc Zyngier <maz@kernel.org>,
Oliver Upton <oliver.upton@linux.dev>,
James Morse <james.morse@arm.com>,
Suzuki K Poulose <suzuki.poulose@arm.com>,
Zenghui Yu <yuzenghui@huawei.com>,
linux-arm-kernel@lists.infradead.org, kvmarm@lists.linux.dev,
Catalin Marinas <catalin.marinas@arm.com>,
Will Deacon <will@kernel.org>
Subject: [PATCH 09/10] KVM: arm64: vgic-its: fix kernel-doc warnings
Date: Wed, 17 Jan 2024 15:07:13 -0800 [thread overview]
Message-ID: <20240117230714.31025-10-rdunlap@infradead.org> (raw)
In-Reply-To: <20240117230714.31025-1-rdunlap@infradead.org>
Correct the function parameter name "@save tables" -> "@save_tables".
Use the "typedef" keyword in the kernel-doc comment for a typedef.
These changes prevent kernel-doc warnings:
vgic/vgic-its.c:174: warning: Function parameter or struct member 'save_tables' not described in 'vgic_its_abi'
arch/arm64/kvm/vgic/vgic-its.c:2152: warning: expecting prototype for entry_fn_t(). Prototype was for int() instead
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>
---
arch/arm64/kvm/vgic/vgic-its.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff -- a/arch/arm64/kvm/vgic/vgic-its.c b/arch/arm64/kvm/vgic/vgic-its.c
--- a/arch/arm64/kvm/vgic/vgic-its.c
+++ b/arch/arm64/kvm/vgic/vgic-its.c
@@ -158,7 +158,7 @@ struct vgic_translation_cache_entry {
* @cte_esz: collection table entry size
* @dte_esz: device table entry size
* @ite_esz: interrupt translation table entry size
- * @save tables: save the ITS tables into guest RAM
+ * @save_tables: save the ITS tables into guest RAM
* @restore_tables: restore the ITS internal structs from tables
* stored in guest RAM
* @commit: initialize the registers which expose the ABI settings,
@@ -2139,7 +2139,7 @@ static u32 compute_next_eventid_offset(s
}
/**
- * entry_fn_t - Callback called on a table entry restore path
+ * typedef entry_fn_t - Callback called on a table entry restore path
* @its: its handle
* @id: id of the entry
* @entry: pointer to the entry
next prev parent reply other threads:[~2024-01-17 23:07 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-17 23:07 [PATCH 00/10] KVM: arm64: fix many " Randy Dunlap
2024-01-17 23:07 ` [PATCH 01/10] KVM: arm64: debug: fix " Randy Dunlap
2024-01-17 23:07 ` [PATCH 02/10] KVM: arm64: guest: " Randy Dunlap
2024-01-17 23:07 ` [PATCH 03/10] KVM: arm64: hyp/aarch32: " Randy Dunlap
2024-01-17 23:07 ` [PATCH 04/10] KVM: arm64: vhe: fix a kernel-doc warning Randy Dunlap
2024-01-17 23:07 ` [PATCH 05/10] KVM: arm64: mmu: " Randy Dunlap
2024-01-17 23:07 ` [PATCH 06/10] KVM: arm64: PMU: fix kernel-doc warnings Randy Dunlap
2024-01-17 23:07 ` [PATCH 07/10] KVM: arm64: sys_regs: " Randy Dunlap
2024-01-17 23:07 ` [PATCH 08/10] KVM: arm64: vgic-init: fix a kernel-doc warning Randy Dunlap
2024-01-17 23:07 ` Randy Dunlap [this message]
2024-01-17 23:07 ` [PATCH 10/10] KVM: arm64: vgic: " Randy Dunlap
2024-02-01 6:19 ` [PATCH 00/10] KVM: arm64: fix many kernel-doc warnings Randy Dunlap
2024-02-01 13:45 ` Marc Zyngier
2024-02-01 17:47 ` Oliver Upton
2024-02-01 10:23 ` Suzuki K Poulose
2024-02-01 13:49 ` Zenghui Yu
2024-02-01 20:30 ` Oliver Upton
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240117230714.31025-10-rdunlap@infradead.org \
--to=rdunlap@infradead.org \
--cc=catalin.marinas@arm.com \
--cc=james.morse@arm.com \
--cc=kvmarm@lists.linux.dev \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=maz@kernel.org \
--cc=oliver.upton@linux.dev \
--cc=suzuki.poulose@arm.com \
--cc=will@kernel.org \
--cc=yuzenghui@huawei.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®