Re: [PATCH v4 10/17] iommufd: IOCTLs for the io_pagetable

Jason Gunthorpe
2022-11-08T17:01:35Z

On Tue, Nov 08, 2022 at 08:27:13PM +0700, Bagas Sanjaya wrote:
> I see kernel-doc warnings (missing short descriptions) when making
> htmldocs, so I have applied the fixup:
>
> ---- >8 ----
>
> From 5643b202ae9853c11434466c76aeaaa044e88b07 Mon Sep 17 00:00:00 2001
> From: Bagas Sanjaya <bagasdotme@gmail.com>
> Date: Tue, 8 Nov 2022 20:14:25 +0700
> Subject: [PATCH] iommufd: Add missing ioctl short descriptions
>
> Checking kernel-doc comments in iommufd.h header with scripts/kernel-doc
> produces missing short description warnings:
>
> include/uapi/linux/iommufd.h:80: warning: missing initial short description on line:
> * struct iommu_iova_range
> include/uapi/linux/iommufd.h:250: warning: missing initial short description on line:
> * enum iommufd_option
> include/uapi/linux/iommufd.h:267: warning: missing initial short description on line:
> * enum iommufd_option_ops
> include/uapi/linux/iommufd.h:277: warning: Cannot understand * @size: sizeof(struct iommu_option)
> on line 277 - I thought it was a doc line
> include/uapi/linux/iommufd.h:299: warning: missing initial short description on line:
> * enum iommufd_vfio_ioas_op
>
> One of them is reported by Stephen Rothwell when merging iommufd tree for
> linux-next.

Thanks, I was about to try to figure out what that was. I squashed it in.

Jason