Skip to content

Commit 3b9a2d5

Browse files
rddunlapawilliam
authored andcommitted
vfio: remove all kernel-doc notation
vfio.c abuses (misuses) "/**", which indicates the beginning of kernel-doc notation in the kernel tree. This causes a bunch of kernel-doc complaints about this source file, so quieten all of them by changing all "/**" to "/*". vfio.c:236: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * IOMMU driver registration vfio.c:236: warning: missing initial short description on line: * IOMMU driver registration vfio.c:295: warning: expecting prototype for Container objects(). Prototype was for vfio_container_get() instead vfio.c:317: warning: expecting prototype for Group objects(). Prototype was for __vfio_group_get_from_iommu() instead vfio.c:496: warning: Function parameter or member 'device' not described in 'vfio_device_put' vfio.c:496: warning: expecting prototype for Device objects(). Prototype was for vfio_device_put() instead vfio.c:599: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * Async device support vfio.c:599: warning: missing initial short description on line: * Async device support vfio.c:693: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * VFIO driver API vfio.c:693: warning: missing initial short description on line: * VFIO driver API vfio.c:835: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * Get a reference to the vfio_device for a device. Even if the vfio.c:835: warning: missing initial short description on line: * Get a reference to the vfio_device for a device. Even if the vfio.c:969: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * VFIO base fd, /dev/vfio/vfio vfio.c:969: warning: missing initial short description on line: * VFIO base fd, /dev/vfio/vfio vfio.c:1187: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * VFIO Group fd, /dev/vfio/$GROUP vfio.c:1187: warning: missing initial short description on line: * VFIO Group fd, /dev/vfio/$GROUP vfio.c:1540: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * VFIO Device fd vfio.c:1540: warning: missing initial short description on line: * VFIO Device fd vfio.c:1615: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * External user API, exported by symbols to be linked dynamically. vfio.c:1615: warning: missing initial short description on line: * External user API, exported by symbols to be linked dynamically. vfio.c:1663: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * External user API, exported by symbols to be linked dynamically. vfio.c:1663: warning: missing initial short description on line: * External user API, exported by symbols to be linked dynamically. vfio.c:1742: warning: Function parameter or member 'caps' not described in 'vfio_info_cap_add' vfio.c:1742: warning: Function parameter or member 'size' not described in 'vfio_info_cap_add' vfio.c:1742: warning: Function parameter or member 'id' not described in 'vfio_info_cap_add' vfio.c:1742: warning: Function parameter or member 'version' not described in 'vfio_info_cap_add' vfio.c:1742: warning: expecting prototype for Sub(). Prototype was for vfio_info_cap_add() instead vfio.c:2276: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst * Module/class support vfio.c:2276: warning: missing initial short description on line: * Module/class support Signed-off-by: Randy Dunlap <[email protected]> Reported-by: kernel test robot <[email protected]> Cc: Jason Gunthorpe <[email protected]> Cc: Alex Williamson <[email protected]> Cc: Eric Auger <[email protected]> Cc: Cornelia Huck <[email protected]> Cc: [email protected] Link: https://lore.kernel.org/r/[email protected] Reviewed-by: Jason Gunthorpe <[email protected]> Reviewed-by: Cornelia Huck <[email protected]> Signed-off-by: Alex Williamson <[email protected]>
1 parent d58071a commit 3b9a2d5

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

drivers/vfio/vfio.c

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ static inline bool vfio_iommu_driver_allowed(struct vfio_container *container,
232232
}
233233
#endif /* CONFIG_VFIO_NOIOMMU */
234234

235-
/**
235+
/*
236236
* IOMMU driver registration
237237
*/
238238
int vfio_register_iommu_driver(const struct vfio_iommu_driver_ops *ops)
@@ -285,7 +285,7 @@ static int vfio_iommu_group_notifier(struct notifier_block *nb,
285285
unsigned long action, void *data);
286286
static void vfio_group_get(struct vfio_group *group);
287287

288-
/**
288+
/*
289289
* Container objects - containers are created when /dev/vfio/vfio is
290290
* opened, but their lifecycle extends until the last user is done, so
291291
* it's freed via kref. Must support container/group/device being
@@ -309,7 +309,7 @@ static void vfio_container_put(struct vfio_container *container)
309309
kref_put(&container->kref, vfio_container_release);
310310
}
311311

312-
/**
312+
/*
313313
* Group objects - create, release, get, put, search
314314
*/
315315
static struct vfio_group *
@@ -488,7 +488,7 @@ static struct vfio_group *vfio_group_get_from_dev(struct device *dev)
488488
return group;
489489
}
490490

491-
/**
491+
/*
492492
* Device objects - create, release, get, put, search
493493
*/
494494
/* Device reference always implies a group reference */
@@ -595,7 +595,7 @@ static int vfio_dev_viable(struct device *dev, void *data)
595595
return ret;
596596
}
597597

598-
/**
598+
/*
599599
* Async device support
600600
*/
601601
static int vfio_group_nb_add_dev(struct vfio_group *group, struct device *dev)
@@ -689,7 +689,7 @@ static int vfio_iommu_group_notifier(struct notifier_block *nb,
689689
return NOTIFY_OK;
690690
}
691691

692-
/**
692+
/*
693693
* VFIO driver API
694694
*/
695695
void vfio_init_group_dev(struct vfio_device *device, struct device *dev,
@@ -831,7 +831,7 @@ int vfio_register_emulated_iommu_dev(struct vfio_device *device)
831831
}
832832
EXPORT_SYMBOL_GPL(vfio_register_emulated_iommu_dev);
833833

834-
/**
834+
/*
835835
* Get a reference to the vfio_device for a device. Even if the
836836
* caller thinks they own the device, they could be racing with a
837837
* release call path, so we can't trust drvdata for the shortcut.
@@ -965,7 +965,7 @@ void vfio_unregister_group_dev(struct vfio_device *device)
965965
}
966966
EXPORT_SYMBOL_GPL(vfio_unregister_group_dev);
967967

968-
/**
968+
/*
969969
* VFIO base fd, /dev/vfio/vfio
970970
*/
971971
static long vfio_ioctl_check_extension(struct vfio_container *container,
@@ -1183,7 +1183,7 @@ static const struct file_operations vfio_fops = {
11831183
.compat_ioctl = compat_ptr_ioctl,
11841184
};
11851185

1186-
/**
1186+
/*
11871187
* VFIO Group fd, /dev/vfio/$GROUP
11881188
*/
11891189
static void __vfio_group_unset_container(struct vfio_group *group)
@@ -1536,7 +1536,7 @@ static const struct file_operations vfio_group_fops = {
15361536
.release = vfio_group_fops_release,
15371537
};
15381538

1539-
/**
1539+
/*
15401540
* VFIO Device fd
15411541
*/
15421542
static int vfio_device_fops_release(struct inode *inode, struct file *filep)
@@ -1611,7 +1611,7 @@ static const struct file_operations vfio_device_fops = {
16111611
.mmap = vfio_device_fops_mmap,
16121612
};
16131613

1614-
/**
1614+
/*
16151615
* External user API, exported by symbols to be linked dynamically.
16161616
*
16171617
* The protocol includes:
@@ -1659,7 +1659,7 @@ struct vfio_group *vfio_group_get_external_user(struct file *filep)
16591659
}
16601660
EXPORT_SYMBOL_GPL(vfio_group_get_external_user);
16611661

1662-
/**
1662+
/*
16631663
* External user API, exported by symbols to be linked dynamically.
16641664
* The external user passes in a device pointer
16651665
* to verify that:
@@ -1725,7 +1725,7 @@ long vfio_external_check_extension(struct vfio_group *group, unsigned long arg)
17251725
}
17261726
EXPORT_SYMBOL_GPL(vfio_external_check_extension);
17271727

1728-
/**
1728+
/*
17291729
* Sub-module support
17301730
*/
17311731
/*
@@ -2272,7 +2272,7 @@ struct iommu_domain *vfio_group_iommu_domain(struct vfio_group *group)
22722272
}
22732273
EXPORT_SYMBOL_GPL(vfio_group_iommu_domain);
22742274

2275-
/**
2275+
/*
22762276
* Module/class support
22772277
*/
22782278
static char *vfio_devnode(struct device *dev, umode_t *mode)

0 commit comments

Comments
 (0)