From: Bart Van Assche <bvanassche@acm.org>
To: "André Almeida" <andrealmeid@collabora.com>,
linux-kernel@vger.kernel.org, linux-scsi@vger.kernel.org,
linux-doc@vger.kernel.org
Cc: corbet@lwn.net, kernel@collabora.com, krisman@collabora.com,
jejb@linux.ibm.com, martin.petersen@oracle.com
Subject: Re: [PATCH 3/3] scsi: core: change function comments to kernel-doc style
Date: Thu, 12 Sep 2019 15:03:44 +0100 [thread overview]
Message-ID: <19eb6b7f-0a62-0e2a-c108-27887b825767@acm.org> (raw)
In-Reply-To: <20190911203735.1332398-3-andrealmeid@collabora.com>
On 9/11/19 9:37 PM, André Almeida wrote:
> +/**
> + * scsi_queue_insert - Insert a command in the midlevel queue.
> + * @cmd: command that we are adding to queue.
> + * @reason: why we are inserting command to queue.
> *
> - * Returns: Nothing.
> + * We do this for one of two cases. Either the host is busy and it cannot accept
> + * any more commands for the time being, or the device returned QUEUE_FULL and
> + * can accept no more commands.
> *
> - * Notes: We do this for one of two cases. Either the host is busy
> - * and it cannot accept any more commands for the time being,
> - * or the device returned QUEUE_FULL and can accept no more
> - * commands.
> - * Notes: This could be called either from an interrupt context or a
> - * normal process context.
> + * Context: This could be called either from an interrupt context or a normal
> + * process context.
> */
What is the midlevel queue? I don't know anyone who still uses that
terminology today. Since the switch to scsi-mq we have software queues
(if no I/O scheduler has been configured), scheduler queue(s) (if an I/O
scheduler has been configured) and hardware queues.
> +/**
> + * scsi_io_completion - Completion processing for block device I/O requests.
> + * @cmd: command that is finished.
That looks inconsistent: the function description refers to block device
I/O requests while what is being completed is a SCSI command.
> + * We will finish off the specified number of sectors. If we are done, the
> + * command block will be released and the queue function will be goosed. If we
> + * are not done then we have to figure out what to do next:
> + *
> + * a) We can call scsi_requeue_command(). The request
> + * will be unprepared and put back on the queue. Then
> + * a new command will be created for it. This should
> + * be used if we made forward progress, or if we want
> + * to switch from READ(10) to READ(6) for example.
I am not aware of any function in the kernel tree that has the name
scsi_requeue_command().
Thanks,
Bart.
next prev parent reply other threads:[~2019-09-12 14:04 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-09-11 20:37 [PATCH 1/3] docs: scsi: fix typo André Almeida
2019-09-11 20:37 ` [PATCH 2/3] scsi: core: remove trailing whitespaces André Almeida
2019-09-12 13:52 ` Bart Van Assche
2019-09-11 20:37 ` [PATCH 3/3] scsi: core: change function comments to kernel-doc style André Almeida
2019-09-12 14:03 ` Bart Van Assche [this message]
2019-09-11 21:10 ` [PATCH 1/3] docs: scsi: fix typo Joe Perches
2019-09-11 21:17 ` André Almeida
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=19eb6b7f-0a62-0e2a-c108-27887b825767@acm.org \
--to=bvanassche@acm.org \
--cc=andrealmeid@collabora.com \
--cc=corbet@lwn.net \
--cc=jejb@linux.ibm.com \
--cc=kernel@collabora.com \
--cc=krisman@collabora.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-scsi@vger.kernel.org \
--cc=martin.petersen@oracle.com \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).