[PATCH v1] docs: xforms_lists: Handle DECLARE_KHOSER_PTR() struct members
Loktionov, Aleksandr
aleksandr.loktionov at intel.com
Wed Oct 21 03:43:55 PDT 2026
> -----Original Message-----
> From: Pasha Tatashin <pasha.tatashin at soleen.com>
> Sent: Thursday, October 15, 2026 4:03 AM
> To: rppt at kernel.org; tudor.ambarus at linaro.org;
> mchehab+huawei at kernel.org; skhan at linuxfoundation.org; linux-
> doc at vger.kernel.org; linux at weissschuh.net; linux-kernel at vger.kernel.org;
> corbet at lwn.net; pasha.tatashin at soleen.com; Loktionov, Aleksandr
> <aleksandr.loktionov at intel.com>; kexec at lists.infradead.org;
> pratyush at kernel.org; rdunlap at infradead.org
> Subject: [PATCH v1] docs: xforms_lists: Handle DECLARE_KHOSER_PTR()
> struct members
>
> 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 at 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
Reviewed-by: Aleksandr Loktionov <aleksandr.loktionov at intel.com>
More information about the kexec
mailing list