[PATCH] iommufd: Fix vEVENTQ kdoc

[PATCH] iommufd: Fix vEVENTQ kdoc

[Nicolin Chen]

Fix the following warnings in veventq kdoc:

include/uapi/linux/iommufd.h:1024: warning: Enum value 'IOMMU_VEVENTQ_FLAG_LOST_EVENTS' not described in enum 'iommu_veventq_flag'
include/uapi/linux/iommufd.h:1024: warning: Excess enum value 'IOMMU_VEVENTQ_FLAG_OVERFLOW' description in 'iommu_veventq_flag'
include/uapi/linux/iommufd.h:1120: warning: Function parameter or struct member 'viommu_id' not described in 'iommu_veventq_alloc'
include/uapi/linux/iommufd.h:1120: warning: Excess struct member 'viommu' description in 'iommu_veventq_alloc'

Fixes: 50c842dd6cd3 ("iommufd: Add IOMMUFD_OBJ_VEVENTQ and IOMMUFD_CMD_VEVENTQ_ALLOC")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/linux-next/20250318214534.5476f9ed@canb.auug.org.au/
Signed-off-by: Nicolin Chen <nicolinc@nvidia.com>
---
 include/uapi/linux/iommufd.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/uapi/linux/iommufd.h b/include/uapi/linux/iommufd.h
index 5fc7e27804b75..8719d4f5d6183 100644
--- a/include/uapi/linux/iommufd.h
+++ b/include/uapi/linux/iommufd.h
@@ -1017,7 +1017,7 @@ struct iommu_ioas_change_process {
 
 /**
  * enum iommu_veventq_flag - flag for struct iommufd_vevent_header
- * @IOMMU_VEVENTQ_FLAG_OVERFLOW: vEVENTQ has lost vEVENTs
+ * @IOMMU_VEVENTQ_FLAG_LOST_EVENTS: vEVENTQ has lost vEVENTs
  */
 enum iommu_veventq_flag {
 	IOMMU_VEVENTQ_FLAG_LOST_EVENTS = (1U << 0),
@@ -1086,7 +1086,7 @@ struct iommu_vevent_arm_smmuv3 {
  * struct iommu_veventq_alloc - ioctl(IOMMU_VEVENTQ_ALLOC)
  * @size: sizeof(struct iommu_veventq_alloc)
  * @flags: Must be 0
- * @viommu: virtual IOMMU ID to associate the vEVENTQ with
+ * @viommu_id: virtual IOMMU ID to associate the vEVENTQ with
  * @type: Type of the vEVENTQ. Must be defined in enum iommu_veventq_type
  * @veventq_depth: Maximum number of events in the vEVENTQ
  * @out_veventq_id: The ID of the new vEVENTQ
-- 
2.34.1

Re: [PATCH] iommufd: Fix vEVENTQ kdoc

[Jason Gunthorpe]

On Tue, Mar 18, 2025 at 09:30:22AM -0700, Nicolin Chen wrote:
> Fix the following warnings in veventq kdoc:
> 
> include/uapi/linux/iommufd.h:1024: warning: Enum value 'IOMMU_VEVENTQ_FLAG_LOST_EVENTS' not described in enum 'iommu_veventq_flag'
> include/uapi/linux/iommufd.h:1024: warning: Excess enum value 'IOMMU_VEVENTQ_FLAG_OVERFLOW' description in 'iommu_veventq_flag'
> include/uapi/linux/iommufd.h:1120: warning: Function parameter or struct member 'viommu_id' not described in 'iommu_veventq_alloc'
> include/uapi/linux/iommufd.h:1120: warning: Excess struct member 'viommu' description in 'iommu_veventq_alloc'
> 
> Fixes: 50c842dd6cd3 ("iommufd: Add IOMMUFD_OBJ_VEVENTQ and IOMMUFD_CMD_VEVENTQ_ALLOC")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Closes: https://lore.kernel.org/linux-next/20250318214534.5476f9ed@canb.auug.org.au/
> Signed-off-by: Nicolin Chen <nicolinc@nvidia.com>
> ---
>  include/uapi/linux/iommufd.h | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)

Thanks, I just squashed it in

Jason