* [PATCH] list.h: add missing kernel-doc for basic macros
@ 2025-08-19 7:55 Randy Dunlap
0 siblings, 0 replies; only message in thread
From: Randy Dunlap @ 2025-08-19 7:55 UTC (permalink / raw)
To: linux-kernel
Cc: Randy Dunlap, Nicolas Frattaroli, Jonathan Corbet, linux-doc,
Andrew Morton
kernel-doc for the basic LIST_HEAD() and LIST_HEAD_INIT() macros has
been missing forever (i.e., since git). Add them for completeness.
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Nicolas Frattaroli <nicolas.frattaroli@collabora.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Cc: Andrew Morton <akpm@linux-foundation.org>
---
include/linux/list.h | 8 ++++++++
1 file changed, 8 insertions(+)
--- linux-next-20250814.orig/include/linux/list.h
+++ linux-next-20250814/include/linux/list.h
@@ -20,8 +20,16 @@
* using the generic single-entry routines.
*/
+/**
+ * LIST_HEAD_INIT - initialize a &struct list_head's links to point to itself
+ * @name: name of the list_head
+ */
#define LIST_HEAD_INIT(name) { &(name), &(name) }
+/**
+ * LIST_HEAD - definition of a &struct list_head with initialization values
+ * @name: name of the list_head
+ */
#define LIST_HEAD(name) \
struct list_head name = LIST_HEAD_INIT(name)
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2025-08-19 7:55 UTC | newest]
Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-08-19 7:55 [PATCH] list.h: add missing kernel-doc for basic macros Randy Dunlap
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).