All of lore.kernel.org
 help / color / mirror / Atom feed
From: Johan Hovold <johan@kernel.org>
To: Gimcuan Hui <gimcuan@gmail.com>
Cc: Johan Hovold <johan@kernel.org>,
	gregkh@linuxfoundation.org, linux-usb@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH] USB: serial: Correct return value on read
Date: Mon, 27 Nov 2017 11:21:15 +0100	[thread overview]
Message-ID: <20171127102115.GB9862@localhost> (raw)
In-Reply-To: <20171126161851.25650-1-gimcuan@gmail.com>

On Sun, Nov 26, 2017 at 04:18:51PM +0000, Gimcuan Hui wrote:
> It's meaningless to return buf[0] on read. Because the caller of this
> interface checks the return value negative or not. Instead, we should
> return the result variable.

It's not really meaningless, it's just that the return value is no
longer being used the way it was originally intended. I think
"redundant" and/or "confusing" would be a more appropriate description.

> Signed-off-by: Gimcuan Hui <gimcuan@gmail.com>
> ---
>  drivers/usb/serial/ark3116.c | 4 +---
>  1 file changed, 1 insertion(+), 3 deletions(-)
> 
> diff --git a/drivers/usb/serial/ark3116.c b/drivers/usb/serial/ark3116.c
> index 3c544782f60b..bfdbc7164e7b 100644
> --- a/drivers/usb/serial/ark3116.c
> +++ b/drivers/usb/serial/ark3116.c
> @@ -101,11 +101,9 @@ static int ark3116_read_reg(struct usb_serial *serial,
>  				reg, result);
>  		if (result >= 0)
>  			result = -EIO;
> -
> -		return result;
>  	}
>  
> -	return buf[0];
> +	return result;

Also we do not want to return the value of result on success as that
would always be 1 (i.e. the buffer size).

You could change this function, and also the write_reg one, to return 0
on success since this is a more common pattern.

Please also rephrase your commit summary (Subject) since you're not
really "correcting" (as in fixing) anything here. This is more a of nice
clean up, even if it could potentially also prevent future bugs.

Thanks,
Johan

  reply	other threads:[~2017-11-27 10:21 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-11-26 16:18 [PATCH] USB: serial: Correct return value on read Gimcuan Hui
2017-11-27 10:21 ` Johan Hovold [this message]
2017-11-27 14:21   ` saks cuso

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20171127102115.GB9862@localhost \
    --to=johan@kernel.org \
    --cc=gimcuan@gmail.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-usb@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.