Re: [PATCH v2 1/8] fwctl: Add basic structure for a class subsystem with a cdev

Jason Gunthorpe
2024-07-22T16:04:15Z

On Tue, Jun 25, 2024 at 11:47:11AM +0700, Bagas Sanjaya wrote:
> 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):

Got it thanks

Jason