diff mbox

[v2,13/36] target: Correct transport_wait_for_tasks() documentation

Message ID 20170202005853.23456-14-bart.vanassche@sandisk.com (mailing list archive)
State Superseded
Headers show

Commit Message

Bart Van Assche Feb. 2, 2017, 12:58 a.m. UTC 
transport_wait_for_tasks() not only waits for command completion
but also sets CMD_T_STOP. Additionally, this function is not only
called by frontend drivers but also by the target core. Update
the transport_wait_for_tasks() documentation to reflect this.

Signed-off-by: Bart Van Assche <bart.vanassche@sandisk.com>
Reviewed-by: Hannes Reinecke <hare@suse.com>
Cc: Christoph Hellwig <hch@lst.de>
Cc: Andy Grover <agrover@redhat.com>
Cc: David Disseldorp <ddiss@suse.de>
---
 drivers/target/target_core_transport.c | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

Comments

Christoph Hellwig Feb. 6, 2017, 9:10 a.m. UTC | #1 
On Wed, Feb 01, 2017 at 04:58:30PM -0800, Bart Van Assche wrote:
> + * transport_wait_for_tasks - set CMD_T_STOP and wait for t_transport_stop_comp
> + * @cmd: command to wait on
>   *
> - * Called from frontend fabric context to wait for storage engine
> - * to pause and/or release frontend generated struct se_cmd.
> + * Returns immediately if CMD_T_ACTIVE has not been set. If CMD_T_ACTIVE has
> + * been set, sets the CMD_T_STOP flag, waits for t_transport_stop_comp and
> + * clears CMD_T_STOP and CMD_T_ACTIVE.
>   */
>  bool transport_wait_for_tasks(struct se_cmd *cmd)

I don't think this adds any value over reading the code just below
it.  I would suggest to just remove the comment.
--
To unsubscribe from this list: send the line "unsubscribe target-devel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Bart Van Assche Feb. 6, 2017, 4:16 p.m. UTC | #2 
On Mon, 2017-02-06 at 01:10 -0800, Christoph Hellwig wrote:
> I don't think this adds any value over reading the code just below
> it.  I would suggest to just remove the comment.

OK, I will drop the comment.

Bart.--
To unsubscribe from this list: send the line "unsubscribe target-devel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/drivers/target/target_core_transport.c b/drivers/target/target_core_transport.c
index 3f54ec6d7f66..daf85bc6ce18 100644
--- a/drivers/target/target_core_transport.c
+++ b/drivers/target/target_core_transport.c
@@ -2770,11 +2770,12 @@  __transport_wait_for_tasks(struct se_cmd *cmd, bool fabric_stop,
 }
 
 /**
- * transport_wait_for_tasks - wait for completion to occur
- * @cmd:	command to wait
+ * transport_wait_for_tasks - set CMD_T_STOP and wait for t_transport_stop_comp
+ * @cmd: command to wait on
  *
- * Called from frontend fabric context to wait for storage engine
- * to pause and/or release frontend generated struct se_cmd.
+ * Returns immediately if CMD_T_ACTIVE has not been set. If CMD_T_ACTIVE has
+ * been set, sets the CMD_T_STOP flag, waits for t_transport_stop_comp and
+ * clears CMD_T_STOP and CMD_T_ACTIVE.
  */
 bool transport_wait_for_tasks(struct se_cmd *cmd)
 {