From: Andrew Donnellan <andrew.donnellan@au1•ibm.com>
To: "Matthew R. Ochs" <mrochs@linux•vnet.ibm.com>,
linux-scsi@vger•kernel.org,
James Bottomley <James.Bottomley@HansenPartnership•com>,
"Nicholas A. Bellinger" <nab@linux-iscsi•org>,
Brian King <brking@linux•vnet.ibm.com>,
Ian Munsie <imunsie@au1•ibm.com>,
Daniel Axtens <dja@ozlabs•au.ibm.com>,
Tomas Henzl <thenzl@redhat•com>,
David Laight <David.Laight@ACULAB•COM>
Cc: Michael Neuling <mikey@neuling•org>,
linuxppc-dev@lists•ozlabs.org,
"Manoj N. Kumar" <manoj@linux•vnet.ibm.com>
Subject: Re: [PATCH v4 23/32] cxlflash: Fix function prolog parameters and return codes
Date: Tue, 29 Sep 2015 14:36:11 +1000 [thread overview]
Message-ID: <560A153B.5000101@au1.ibm.com> (raw)
In-Reply-To: <1443223098-9809-1-git-send-email-mrochs@linux.vnet.ibm.com>
On 26/09/15 09:18, Matthew R. Ochs wrote:
> Several function prologs have incorrect parameter names and return
> code descriptions. This can lead to confusion when reviewing the
> source and creates inaccurate documentation.
>
> To remedy, update the function prologs to properly reflect parameter
> names and return codes.
>
> Signed-off-by: Matthew R. Ochs <mrochs@linux•vnet.ibm.com>
> Signed-off-by: Manoj N. Kumar <manoj@linux•vnet.ibm.com>
> Reviewed-by: Brian King <brking@linux•vnet.ibm.com>
Reviewed-by: Andrew Donnellan <andrew.donnellan@au1•ibm.com>
See further comments below.
> --- a/drivers/scsi/cxlflash/main.c
> +++ b/drivers/scsi/cxlflash/main.c
> @@ -401,8 +401,7 @@ static void wait_resp(struct afu *afu, struct afu_cmd *cmd)
> * @tmfcmd: TMF command to send.
> *
> * Return:
> - * 0 on success
> - * SCSI_MLQUEUE_HOST_BUSY when host is busy
> + * 0 on success or SCSI_MLQUEUE_HOST_BUSY
> */
> static int send_tmf(struct afu *afu, struct scsi_cmnd *scp, u64 tmfcmd)
> {
> @@ -491,9 +490,7 @@ static const char *cxlflash_driver_info(struct Scsi_Host *host)
> * @host: SCSI host associated with device.
> * @scp: SCSI command to send.
> *
> - * Return:
> - * 0 on success
> - * SCSI_MLQUEUE_HOST_BUSY when host is busy
> + * Return: 0 on success or SCSI_MLQUEUE_HOST_BUSY
> */
I'd prefer it to say "SCSI_MLQUEUE_HOST_BUSY on failure". (Aesthetically
I prefer having it on a separate line, but that's just personal preference.)
As an aside, while checking the correctness of this, I found that the
comment for cxlflash_send_cmd() states that it returns -1 on failure,
when the only error value it actually returns is SCSI_MLQUEUE_HOST_BUSY.
If you send a v5 you might want to fix this.
Andrew
--
Andrew Donnellan Software Engineer, OzLabs
andrew.donnellan@au1•ibm.com Australia Development Lab, Canberra
+61 2 6201 8874 (work) IBM Australia Limited
next prev parent reply other threads:[~2015-09-29 4:36 UTC|newest]
Thread overview: 68+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-09-25 23:09 [PATCH v4 00/32] cxlflash: Miscellaneous bug fixes and corrections Matthew R. Ochs
2015-09-25 23:12 ` [PATCH v4 01/32] cxlflash: Fix to avoid invalid port_sel value Matthew R. Ochs
2015-09-25 23:12 ` [PATCH v4 02/32] cxlflash: Replace magic numbers with literals Matthew R. Ochs
2015-09-29 5:40 ` Andrew Donnellan
2015-09-25 23:12 ` [PATCH v4 03/32] cxlflash: Fix read capacity timeout Matthew R. Ochs
2015-09-25 23:13 ` [PATCH v4 04/32] cxlflash: Fix potential oops following LUN removal Matthew R. Ochs
2015-09-25 23:13 ` [PATCH v4 05/32] cxlflash: Fix data corruption when vLUN used over multiple cards Matthew R. Ochs
2015-09-25 23:14 ` [PATCH v4 06/32] cxlflash: Fix to avoid sizeof(bool) Matthew R. Ochs
2015-09-28 22:35 ` Daniel Axtens
2015-09-25 23:14 ` [PATCH v4 07/32] cxlflash: Fix context encode mask width Matthew R. Ochs
2015-09-28 22:39 ` Daniel Axtens
2015-09-25 23:14 ` [PATCH v4 08/32] cxlflash: Fix to avoid CXL services during EEH Matthew R. Ochs
2015-09-28 22:07 ` Brian King
2015-09-28 23:05 ` Daniel Axtens
2015-09-29 19:28 ` Matthew R. Ochs
2015-09-25 23:14 ` [PATCH v4 09/32] cxlflash: Correct naming of limbo state and waitq Matthew R. Ochs
2015-09-28 23:09 ` Daniel Axtens
2015-09-25 23:14 ` [PATCH v4 10/32] cxlflash: Make functions static Matthew R. Ochs
2015-09-25 23:14 ` [PATCH v4 11/32] cxlflash: Refine host/device attributes Matthew R. Ochs
2015-09-29 4:29 ` Andrew Donnellan
2015-09-25 23:15 ` [PATCH v4 12/32] cxlflash: Fix to avoid spamming the kernel log Matthew R. Ochs
2015-09-29 5:05 ` Andrew Donnellan
2015-09-29 20:37 ` Matthew R. Ochs
2015-09-25 23:16 ` [PATCH v4 13/32] cxlflash: Fix to avoid stall while waiting on TMF Matthew R. Ochs
2015-09-25 23:16 ` [PATCH v4 14/32] cxlflash: Fix location of setting resid Matthew R. Ochs
2015-09-25 23:16 ` [PATCH v4 15/32] cxlflash: Fix host link up event handling Matthew R. Ochs
2015-09-25 23:16 ` [PATCH v4 16/32] cxlflash: Fix async interrupt bypass logic Matthew R. Ochs
2015-09-25 23:16 ` [PATCH v4 17/32] cxlflash: Remove dual port online dependency Matthew R. Ochs
2015-09-28 23:37 ` Daniel Axtens
2015-09-29 19:38 ` Matthew R. Ochs
2015-09-30 23:50 ` Daniel Axtens
2015-10-01 15:00 ` Matthew R. Ochs
2015-09-25 23:17 ` [PATCH v4 18/32] cxlflash: Fix AFU version access/storage and add check Matthew R. Ochs
2015-09-25 23:17 ` [PATCH v4 19/32] cxlflash: Correct usage of scsi_host_put() Matthew R. Ochs
2015-09-25 23:17 ` [PATCH v4 20/32] cxlflash: Fix to prevent workq from accessing freed memory Matthew R. Ochs
2015-09-25 23:17 ` [PATCH v4 21/32] cxlflash: Correct behavior in device reset handler following EEH Matthew R. Ochs
2015-09-25 23:17 ` [PATCH v4 22/32] cxlflash: Remove unnecessary scsi_block_requests Matthew R. Ochs
2015-09-25 23:18 ` [PATCH v4 23/32] cxlflash: Fix function prolog parameters and return codes Matthew R. Ochs
2015-09-29 4:36 ` Andrew Donnellan [this message]
2015-09-29 20:31 ` Matthew R. Ochs
2015-09-25 23:18 ` [PATCH v4 24/32] cxlflash: Fix MMIO and endianness errors Matthew R. Ochs
2015-09-29 1:52 ` Andrew Donnellan
2015-09-25 23:18 ` [PATCH v4 25/32] cxlflash: Fix to prevent EEH recovery failure Matthew R. Ochs
2015-09-29 1:25 ` Daniel Axtens
2015-09-29 20:11 ` Matthew R. Ochs
2015-09-30 23:53 ` Daniel Axtens
2015-09-25 23:18 ` [PATCH v4 26/32] cxlflash: Correct spelling, grammar, and alignment mistakes Matthew R. Ochs
2015-09-29 1:18 ` Andrew Donnellan
2015-09-25 23:19 ` [PATCH v4 27/32] cxlflash: Fix to prevent stale AFU RRQ Matthew R. Ochs
2015-09-29 1:36 ` Daniel Axtens
2015-09-29 20:22 ` Matthew R. Ochs
2015-09-30 23:51 ` Daniel Axtens
2015-09-25 23:19 ` [PATCH v4 28/32] MAINTAINERS: Add cxlflash driver Matthew R. Ochs
2015-09-25 23:19 ` [PATCH v4 29/32] cxlflash: Fix to double the delay each time Matthew R. Ochs
2015-09-29 1:19 ` Andrew Donnellan
2015-09-29 1:40 ` Daniel Axtens
2015-09-29 20:28 ` Matthew R. Ochs
2015-09-30 0:08 ` Daniel Axtens
2015-09-25 23:19 ` [PATCH v4 30/32] cxlflash: Fix to avoid corrupting adapter fops Matthew R. Ochs
2015-09-28 22:13 ` Brian King
2015-09-29 0:54 ` Andrew Donnellan
2015-09-30 0:18 ` Daniel Axtens
2015-09-25 23:19 ` [PATCH v4 31/32] cxlflash: Correct trace string Matthew R. Ochs
2015-09-29 1:20 ` Andrew Donnellan
2015-09-25 23:19 ` [PATCH v4 32/32] cxlflash: Fix to avoid potential deadlock on EEH Matthew R. Ochs
2015-09-28 23:41 ` Brian King
2015-09-29 19:40 ` Matthew R. Ochs
2015-09-30 0:33 ` Daniel Axtens
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=560A153B.5000101@au1.ibm.com \
--to=andrew.donnellan@au1$(echo .)ibm.com \
--cc=David.Laight@ACULAB$(echo .)COM \
--cc=James.Bottomley@HansenPartnership$(echo .)com \
--cc=brking@linux$(echo .)vnet.ibm.com \
--cc=dja@ozlabs$(echo .)au.ibm.com \
--cc=imunsie@au1$(echo .)ibm.com \
--cc=linux-scsi@vger$(echo .)kernel.org \
--cc=linuxppc-dev@lists$(echo .)ozlabs.org \
--cc=manoj@linux$(echo .)vnet.ibm.com \
--cc=mikey@neuling$(echo .)org \
--cc=mrochs@linux$(echo .)vnet.ibm.com \
--cc=nab@linux-iscsi$(echo .)org \
--cc=thenzl@redhat$(echo .)com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox