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

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>] [day] [month] [year] [list]

Message-ID: <20250819075507.113639-1-rdunlap@infradead.org>
Date: Tue, 19 Aug 2025 00:55:07 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: linux-kernel@...r.kernel.org
Cc: Randy Dunlap <rdunlap@...radead.org>,
	Nicolas Frattaroli <nicolas.frattaroli@...labora.com>,
	Jonathan Corbet <corbet@....net>,
	linux-doc@...r.kernel.org,
	Andrew Morton <akpm@...ux-foundation.org>
Subject: [PATCH] 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.

Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
Cc: Nicolas Frattaroli <nicolas.frattaroli@...labora.com>
Cc: Jonathan Corbet <corbet@....net>
Cc: linux-doc@...r.kernel.org
Cc: Andrew Morton <akpm@...ux-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)