[<prev] [next>] [thread-next>] [day] [month] [year] [list]
Message-ID: <20240123053329.12893-1-rdunlap@infradead.org>
Date: Mon, 22 Jan 2024 21:33:29 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: linux-kernel@...r.kernel.org
Cc: Randy Dunlap <rdunlap@...radead.org>,
Bjorn Andersson <andersson@...nel.org>,
Konrad Dybcio <konrad.dybcio@...aro.org>,
linux-arm-msm@...r.kernel.org,
Jeff Johnson <quic_jjohnson@...cinc.com>
Subject: [PATCH v2] soc: qcom: smp2p: fix all kernel-doc warnings
Use the documented notation for nested struct members.
Add a Return: comment for qcom_smp2p_intr().
These changes prevent these kernel-doc warnings:
smp2p.c:78: warning: Excess struct member 'name' description in 'smp2p_smem_item'
smp2p.c:78: warning: Excess struct member 'value' description in 'smp2p_smem_item'
smp2p.c:280: warning: No description found for return value of 'qcom_smp2p_intr'
Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
Cc: Bjorn Andersson <andersson@...nel.org>
Cc: Konrad Dybcio <konrad.dybcio@...aro.org>
Cc: linux-arm-msm@...r.kernel.org
Cc: Jeff Johnson <quic_jjohnson@...cinc.com>
---
v2: use Return: instead of Returns: for consistency with documentation
(Jeff Johnson)
drivers/soc/qcom/smp2p.c | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff -- a/drivers/soc/qcom/smp2p.c b/drivers/soc/qcom/smp2p.c
--- a/drivers/soc/qcom/smp2p.c
+++ b/drivers/soc/qcom/smp2p.c
@@ -58,8 +58,8 @@
* @valid_entries: number of allocated entries
* @flags:
* @entries: individual communication entries
- * @name: name of the entry
- * @value: content of the entry
+ * @entries.name: name of the entry
+ * @entries.value: content of the entry
*/
struct smp2p_smem_item {
u32 magic;
@@ -275,6 +275,8 @@ static void qcom_smp2p_notify_in(struct
*
* Handle notifications from the remote side to handle newly allocated entries
* or any changes to the state bits of existing entries.
+ *
+ * Return: %IRQ_HANDLED
*/
static irqreturn_t qcom_smp2p_intr(int irq, void *data)
{
Powered by blists - more mailing lists