linux-kernel - Re: [PATCH v5 2/5] kernel-doc: add support to handle DEFINE

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

Message-ID: <e1dad7e4-a0ca-4be6-a33c-97b75175c12f@infradead.org>
Date: Wed, 26 Nov 2025 17:27:34 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
 Linux Doc Mailing List <linux-doc@...r.kernel.org>,
 Jonathan Corbet <corbet@....net>
Cc: Mauro Carvalho Chehab <mchehab@...nel.org>, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v5 2/5] kernel-doc: add support to handle DEFINE_
 variables

Hi Mauro,

On 11/24/25 1:57 AM, Mauro Carvalho Chehab wrote:
> Improve the parser and output plugin to work with macros,
> adding support for the common pattern of using DEFINE_*
> to create variables.
> 

I can't get this one to work: it is completely ignored AFAICT:

from the init/kdoc-globals-test.c file that I provided earlier:

/**
 * var rtnl_mutex - historical global lock for networking control operations.
 *
 * @rtnl_mutex is used to serialize rtnetlink requests
 * and protect all kernel internal data structures related to networking.
 *
 * See Documentation/networking/netdevices.rst for details.
 * Often known as the rtnl_lock, although rtnl_lock is a kernel function.
 */
static DEFINE_MUTEX(rtnl_mutex);

If I remove the beginning "static " and change its name to test_mutex, kdoc reports:

WARNING: ../init/kdoc-globals-test.c:100 DEFINE_MUTEX(test_mutex);: can't parse variable

I have both of these mutexes in my test file now. Here is the second one:

/**
 * var test_mutex - historical global lock for networking control operations.
 *
 * @test_mutex is used to serialize rtnetlink requests
 * and protect all kernel internal data structures related to networking.
 *
 * See Documentation/networking/netdevices.rst for details.
 * Often known as the test_lock, although test_lock is a kernel function.
 */
DEFINE_MUTEX(test_mutex);

-- 
~Randy