[PATCH] list.h: add missing kernel-doc for basic macros

Randy Dunlap posted 1 patch 1 month, 2 weeks ago
include/linux/list.h |    8 ++++++++
1 file changed, 8 insertions(+)
[PATCH] list.h: add missing kernel-doc for basic macros
Posted by Randy Dunlap 1 month, 2 weeks ago
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)