From: Randy Dunlap <rdunlap@infradead.org>
To: Pasha Tatashin <pasha.tatashin@soleen.com>,
rppt@kernel.org, tudor.ambarus@linaro.org,
mchehab+huawei@kernel.org, skhan@linuxfoundation.org,
linux-doc@vger.kernel.org, linux@weissschuh.net,
linux-kernel@vger.kernel.org, corbet@lwn.net,
aleksandr.loktionov@intel.com, kexec@lists.infradead.org,
pratyush@kernel.org
Subject: Re: [PATCH v1] docs: xforms_lists: Handle DECLARE_KHOSER_PTR() struct members
Date: Wed, 14 Oct 2026 20:41:25 -0700 [thread overview]
Message-ID: <f469c550-5d02-4648-a8ec-b154f2db3c57@infradead.org> (raw)
In-Reply-To: <20261015020313.946940-1-pasha.tatashin@soleen.com>
On 10/14/26 7:03 PM, Pasha Tatashin wrote:
> KHO ABI structures declare their preservation pointers with
> DECLARE_KHOSER_PTR(name, type), which expands to a union of the pointer
> and its physical address. kernel-doc does not know the macro and does
> not see the member: it warns that an unnamed member is not described
> and that the description of the member is excess.
>
> Translate DECLARE_KHOSER_PTR(name, type) into "type name", as is done
> for DECLARE_KFIFO_PTR().
>
> Signed-off-by: Pasha Tatashin <pasha.tatashin@soleen.com>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.
> ---
> tools/lib/python/kdoc/xforms_lists.py | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/tools/lib/python/kdoc/xforms_lists.py b/tools/lib/python/kdoc/xforms_lists.py
> index e3dda2fe8a537..e81d8a7702cbb 100644
> --- a/tools/lib/python/kdoc/xforms_lists.py
> +++ b/tools/lib/python/kdoc/xforms_lists.py
> @@ -45,6 +45,7 @@ class CTransforms:
> (CMatch("DECLARE_HASHTABLE"), r"unsigned long \1[1 << ((\2) - 1)]"),
> (CMatch("DECLARE_KFIFO"), r"\2 *\1"),
> (CMatch("DECLARE_KFIFO_PTR"), r"\2 *\1"),
> + (CMatch("DECLARE_KHOSER_PTR"), r"\2 \1"),
> (CMatch("(?:__)?DECLARE_FLEX_ARRAY"), r"\1 \2[]"),
> (CMatch("DEFINE_DMA_UNMAP_ADDR"), r"dma_addr_t \1"),
> (CMatch("DEFINE_DMA_UNMAP_LEN"), r"__u32 \1"),
>
> base-commit: cee9395acd8043be0644b25c34bfa86623f2b935
> prerequisite-patch-id: 557b4f406b7530b8be07d3e3aa6015ad89ceaa6d
> prerequisite-patch-id: c0430a4f0096e4be93a6200aa4e8a1d392238ca5
> prerequisite-patch-id: 524c71eab38a9175f9920f38717c8ed3b157299f
> prerequisite-patch-id: 61cfc274edef2fb23a1b867c9e0d063578387c45
> prerequisite-patch-id: ac022b05628f8e495a224216352aa037a022aae4
> prerequisite-patch-id: 50668baf257da9873190d08f21538ddc453261a8
--
~Randy
next prev parent reply other threads:[~2026-10-15 3:41 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-10-15 2:03 Pasha Tatashin
2026-10-15 3:41 ` Randy Dunlap [this message]
2026-10-15 8:10 ` Mike Rapoport
2026-10-21 10:43 ` Loktionov, Aleksandr
2026-10-22 15:51 ` Jonathan Corbet
2026-10-22 16:33 ` Pasha Tatashin
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=f469c550-5d02-4648-a8ec-b154f2db3c57@infradead.org \
--to=rdunlap@infradead.org \
--cc=aleksandr.loktionov@intel.com \
--cc=corbet@lwn.net \
--cc=kexec@lists.infradead.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@weissschuh.net \
--cc=mchehab+huawei@kernel.org \
--cc=pasha.tatashin@soleen.com \
--cc=pratyush@kernel.org \
--cc=rppt@kernel.org \
--cc=skhan@linuxfoundation.org \
--cc=tudor.ambarus@linaro.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®