linux-kernel - [PATCH] net: Add kerneldoc comment to napi_complete

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <20230129132618.1361421-1-j.neuschaefer@gmx.net>
Date:   Sun, 29 Jan 2023 14:26:18 +0100
From:   Jonathan Neuschäfer <j.neuschaefer@....net>
To:     netdev@...r.kernel.org
Cc:     Jonathan Neuschäfer <j.neuschaefer@....net>,
        "David S. Miller" <davem@...emloft.net>,
        Eric Dumazet <edumazet@...gle.com>,
        Jakub Kicinski <kuba@...nel.org>,
        Paolo Abeni <pabeni@...hat.com>, linux-kernel@...r.kernel.org
Subject: [PATCH] net: Add kerneldoc comment to napi_complete_done

Document napi_complete_done, so that it shows up in HTML documentation.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@....net>
---
 include/linux/netdevice.h | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/include/linux/netdevice.h b/include/linux/netdevice.h
index aad12a179e540..828e58791baa1 100644
--- a/include/linux/netdevice.h
+++ b/include/linux/netdevice.h
@@ -504,7 +504,16 @@ static inline bool napi_reschedule(struct napi_struct *napi)
 	return false;
 }

+/**
+ *	napi_complete_done - NAPI processing complete
+ *	@n: NAPI context
+ *	@work_done: The number of packets that were processed
+ *
+ * Mark NAPI processing as complete.
+ * Return false if device should avoid rearming interrupts.
+ */
 bool napi_complete_done(struct napi_struct *n, int work_done);
+
 /**
  *	napi_complete - NAPI processing complete
  *	@n: NAPI context
--
2.39.0