Re: [PATCH] Staging: comedi: drivers: fixed errors warning coding style issue

From: Greg KH
Date: Sun Feb 16 2020 - 07:22:03 EST


On Sun, Feb 16, 2020 at 01:45:18PM +0530, sunnypranay wrote:
> Fixed a coding style issue.

What issue?

>
> Signed-off-by: sunnypranay <mpranay2017@xxxxxxxxx>

We need a "real" name here, one that you use for documents.

> ---
> drivers/staging/comedi/drivers.c | 18 +++++++++++++++---
> 1 file changed, 15 insertions(+), 3 deletions(-)
>
> diff --git a/drivers/staging/comedi/drivers.c b/drivers/staging/comedi/drivers.c
> index 750a6ff3c03c..76395de100a6 100644
> --- a/drivers/staging/comedi/drivers.c
> +++ b/drivers/staging/comedi/drivers.c
> @@ -133,7 +133,7 @@ EXPORT_SYMBOL_GPL(comedi_alloc_subdevices);
> * On success, @s->readback points to the first element of the array, which
> * is zero-filled. The low-level driver is responsible for updating its
> * contents. @s->insn_read will be set to comedi_readback_insn_read()
> - * unless it is already non-NULL.
> + * Unless it is already non-NULL.
> *
> * Returns 0 on success, -EINVAL if the subdevice has no channels, or
> * -ENOMEM on allocation failure.
> @@ -282,8 +282,20 @@ EXPORT_SYMBOL_GPL(comedi_readback_insn_read);
> * continue waiting or some other value to stop waiting (generally 0 if the
> * condition occurred, or some error value).
> *
> - * Returns -ETIMEDOUT if timed out, otherwise the return value from the
> - * callback function.
> + * Redback_insn_read() - A generic (*insn_read) for subdevice readback.
> + * @dev: COMEDI device.
> + * @s: COMEDI subdevice.
> + * @insn: COMEDI instruction.
> + * @data: Pointer to return the readback data.
> + * Handles the %INSN_READ instruction for subdevices that use the readback
> + * array allocated by comedi_alloc_subdev_readback(). It may be used
> + * directly as the subdevice's handler (@s->insn_read) or called via a
> + * wrapper.
> + * @insn->n is normally 1, which will read a single value. If higher, the
> + * same element of the readback array will be read multiple times.
> + * Returns @insn->n on success,
> + * or -EINVAL if @s->readback is NULL.turns -ETIMEDOUT if timed out,
> + * otherwise the return value from the callback function.

Where did all of that come from?

thanks,

greg k-h