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

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

[sunnypranay]

Fixed a coding style issue.

Signed-off-by: sunnypranay <mpranay2017@gmail.com>
---
 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.
  */
 int comedi_timeout(struct comedi_device *dev,
 		   struct comedi_subdevice *s,
-- 
2.17.1

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

[Greg KH]

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

What issue?

> 
> Signed-off-by: sunnypranay <mpranay2017@gmail.com>

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

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

[Greg KH]

On Sun, Feb 16, 2020 at 06:16:56PM +0530, Sunny Pranay wrote:
> > Before the patch were created there were few warnings indicating the
> statements were bigger than 80 characters and some of them were not
> properly commented like having extra space. So I created a patch for that
> reducing comments to below 80 characters and maintained proper spacing.
> That was I meant by fixed coding style issue.
> 
> > My original name is M Pranay

Ok, then please fix this by properly saying all of this in the changelog
text when you resubmit the patch.

thanks,

greg k-h

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

[Dan Carpenter]

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

What issue is that?

> 
> Signed-off-by: sunnypranay <mpranay2017@gmail.com>

This doesn't seem like a Formal Name that you would use to sign legal
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.

The original capitalization was correct.  It should be lower case.

>   *
>   * 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.
      ^^^^^^^^^^^^^^^^^
What is this???

regards,
dan carpenter