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

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

Commit Message

Lee Jones July 13, 2020, 7:59 a.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: Stefan Hajnoczi <stefanha@redhat.com>
Cc: virtualization@lists.linux-foundation.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>

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

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

-- 
2.25.1

Comments

Michael S. Tsirkin July 13, 2020, 11:23 a.m. | #1
On Mon, Jul 13, 2020 at 08:59:49AM +0100, 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: Stefan Hajnoczi <stefanha@redhat.com>

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

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

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


Acked-by: Michael S. Tsirkin <mst@redhat.com>


Pls merge with the rest of the patches (which tree is this for?)

> ---

>  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.

> -- 

> 2.25.1
Lee Jones July 13, 2020, 11:53 a.m. | #2
On Mon, 13 Jul 2020, Michael S. Tsirkin wrote:

> On Mon, Jul 13, 2020 at 08:59:49AM +0100, 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: Stefan Hajnoczi <stefanha@redhat.com>

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

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

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

> 

> Acked-by: Michael S. Tsirkin <mst@redhat.com>


Thank you Michael.

> Pls merge with the rest of the patches (which tree is this for?)


My assumption is that Martin will take all of these (and the other
sets) via the SCSI repo.

-- 
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog

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.