On Mon, Jun 24, 2024 at 07:47:25PM -0300, Jason Gunthorpe wrote: > +/** > + * fwctl_alloc_device - Allocate a fwctl > + * @parent: Physical device that provides the FW interface > + * @ops: Driver ops to register > + * @drv_struct: 'struct driver_fwctl' that holds the struct fwctl_device > + * @member: Name of the struct fwctl_device in @drv_struct > + * > + * This allocates and initializes the fwctl_device embedded in the drv_struct. > + * Upon success the pointer must be freed via fwctl_put(). Returns NULL on > + * failure. Returns a 'drv_struct *' on success, NULL on error. > + */ Sphinx reports htmldocs warning: Documentation/userspace-api/fwctl:195: ./include/linux/fwctl.h:72: WARNING: Inline emphasis start-string without end-string. I have to escape the pointer (while also cleaning up redundant wordings on error case): ---- >8 ---- diff --git a/include/linux/fwctl.h b/include/linux/fwctl.h index 294cfbf63306a2..ddadbe15189b45 100644 --- a/include/linux/fwctl.h +++ b/include/linux/fwctl.h @@ -70,8 +70,8 @@ struct fwctl_device *_fwctl_alloc_device(struct device *parent, * @member: Name of the struct fwctl_device in @drv_struct * * This allocates and initializes the fwctl_device embedded in the drv_struct. - * Upon success the pointer must be freed via fwctl_put(). Returns NULL on - * failure. Returns a 'drv_struct *' on success, NULL on error. + * Upon success the pointer must be freed via fwctl_put(). Returns a + * 'drv_struct \*' on success, NULL on error. */ #define fwctl_alloc_device(parent, ops, drv_struct, member) \ container_of(_fwctl_alloc_device( \ Thanks. -- An old man doll... just what I always wanted! - Clara
Attachment:
signature.asc
Description: PGP signature
