* [PATCH v1] docs: xforms_lists: Handle DECLARE_KHOSER_PTR() struct members
@ 2026-10-15 2:03 Pasha Tatashin
2026-10-15 3:41 ` Randy Dunlap
2026-10-15 8:10 ` Mike Rapoport
0 siblings, 2 replies; 3+ messages in thread
From: Pasha Tatashin @ 2026-10-15 2:03 UTC (permalink / raw)
To: rppt, tudor.ambarus, mchehab+huawei, skhan, linux-doc, linux,
linux-kernel, corbet, pasha.tatashin, aleksandr.loktionov, kexec,
pratyush, rdunlap
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>
---
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
--
2.56.0.385.gd3acb90ef8-goog
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH v1] docs: xforms_lists: Handle DECLARE_KHOSER_PTR() struct members
2026-10-15 2:03 [PATCH v1] docs: xforms_lists: Handle DECLARE_KHOSER_PTR() struct members Pasha Tatashin
@ 2026-10-15 3:41 ` Randy Dunlap
2026-10-15 8:10 ` Mike Rapoport
1 sibling, 0 replies; 3+ messages in thread
From: Randy Dunlap @ 2026-10-15 3:41 UTC (permalink / raw)
To: Pasha Tatashin, rppt, tudor.ambarus, mchehab+huawei, skhan,
linux-doc, linux, linux-kernel, corbet, aleksandr.loktionov,
kexec, pratyush
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
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH v1] docs: xforms_lists: Handle DECLARE_KHOSER_PTR() struct members
2026-10-15 2:03 [PATCH v1] docs: xforms_lists: Handle DECLARE_KHOSER_PTR() struct members Pasha Tatashin
2026-10-15 3:41 ` Randy Dunlap
@ 2026-10-15 8:10 ` Mike Rapoport
1 sibling, 0 replies; 3+ messages in thread
From: Mike Rapoport @ 2026-10-15 8:10 UTC (permalink / raw)
To: Pasha Tatashin
Cc: tudor.ambarus, mchehab+huawei, skhan, linux-doc, linux,
linux-kernel, corbet, aleksandr.loktionov, kexec, pratyush,
rdunlap
On Wed, Oct 14, 2026 at 10:03:13PM -0400, 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>
Acked-by: Mike Rapoport (Microsoft) <rppt@kernel.org>
> ---
> 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
> --
> 2.56.0.385.gd3acb90ef8-goog
>
--
Sincerely yours,
Mike.
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2026-10-15 8:10 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-10-15 2:03 [PATCH v1] docs: xforms_lists: Handle DECLARE_KHOSER_PTR() struct members Pasha Tatashin
2026-10-15 3:41 ` Randy Dunlap
2026-10-15 8:10 ` Mike Rapoport
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox