From: Randy Dunlap <rdunlap@infradead.org>
Date: Tue, 19 Aug 2025 07:55:07 +0000 (-0700)
Subject: list.h: add missing kernel-doc for basic macros
X-Git-Url: https://www.infradead.org/git/?a=commitdiff_plain;h=2a8c51bc9391ff3c701f06ae1b678419f843dc1a;p=users%2Fhch%2Fmisc.git

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

kernel-doc for the basic LIST_HEAD() and LIST_HEAD_INIT() macros has been
missing forever (i.e., since git).  Add them for completeness.

Link: https://lkml.kernel.org/r/20250819075507.113639-1-rdunlap@infradead.org
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Nicolas Frattaroli <nicolas.frattaroli@collabora.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
---

diff --git a/include/linux/list.h b/include/linux/list.h
index e7e28afd28f8..ca63bdea6c1a 100644
--- a/include/linux/list.h
+++ b/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)