[12/24] scsi: virtio_scsi: Demote seemingly unintentional kerneldoc header

Message ID 20200709174556.7651-13-lee.jones@linaro.org
State Superseded
Headers show
Series
  • Set 3: Fix another set of SCSI related W=1 warnings
Related show

Commit Message

Lee Jones July 9, 2020, 5:45 p.m.
This is the only use of kerneldoc in the sourcefile and no
descriptions are provided.

Fixes the following W=1 kernel build warning(s):

 drivers/scsi/virtio_scsi.c:109: warning: Function parameter or member 'vscsi' not described in 'virtscsi_complete_cmd'
 drivers/scsi/virtio_scsi.c:109: warning: Function parameter or member 'buf' not described in 'virtscsi_complete_cmd'

Cc: "Michael S. Tsirkin" <mst@redhat.com>
Cc: Jason Wang <jasowang@redhat.com>
Cc: Paolo Bonzini <pbonzini@redhat.com>
Cc: Stefan Hajnoczi <stefanha@redhat.com>
Cc: virtualization@lists.linux-foundation.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>

---
 drivers/scsi/virtio_scsi.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

-- 
2.25.1

Comments

Paolo Bonzini July 9, 2020, 6:01 p.m. | #1
On 09/07/20 19:45, Lee Jones wrote:
> This is the only use of kerneldoc in the sourcefile and no

> descriptions are provided.

> 

> Fixes the following W=1 kernel build warning(s):

> 

>  drivers/scsi/virtio_scsi.c:109: warning: Function parameter or member 'vscsi' not described in 'virtscsi_complete_cmd'

>  drivers/scsi/virtio_scsi.c:109: warning: Function parameter or member 'buf' not described in 'virtscsi_complete_cmd'

> 

> Cc: "Michael S. Tsirkin" <mst@redhat.com>

> Cc: Jason Wang <jasowang@redhat.com>

> Cc: Paolo Bonzini <pbonzini@redhat.com>

> Cc: Stefan Hajnoczi <stefanha@redhat.com>

> Cc: virtualization@lists.linux-foundation.org

> Signed-off-by: Lee Jones <lee.jones@linaro.org>

> ---

>  drivers/scsi/virtio_scsi.c | 2 +-

>  1 file changed, 1 insertion(+), 1 deletion(-)

> 

> diff --git a/drivers/scsi/virtio_scsi.c b/drivers/scsi/virtio_scsi.c

> index 0e0910c5b9424..56875467e4984 100644

> --- a/drivers/scsi/virtio_scsi.c

> +++ b/drivers/scsi/virtio_scsi.c

> @@ -100,7 +100,7 @@ static void virtscsi_compute_resid(struct scsi_cmnd *sc, u32 resid)

>  		scsi_set_resid(sc, resid);

>  }

>  

> -/**

> +/*

>   * virtscsi_complete_cmd - finish a scsi_cmd and invoke scsi_done

>   *

>   * Called with vq_lock held.

> 


Acked-by: Paolo Bonzini <pbonzini@redhat.com>

Patch

diff --git a/drivers/scsi/virtio_scsi.c b/drivers/scsi/virtio_scsi.c
index 0e0910c5b9424..56875467e4984 100644
--- a/drivers/scsi/virtio_scsi.c
+++ b/drivers/scsi/virtio_scsi.c
@@ -100,7 +100,7 @@  static void virtscsi_compute_resid(struct scsi_cmnd *sc, u32 resid)
 		scsi_set_resid(sc, resid);
 }
 
-/**
+/*
  * virtscsi_complete_cmd - finish a scsi_cmd and invoke scsi_done
  *
  * Called with vq_lock held.