drivers/virtio/virtio_dma_buf.c | 2 ++ 1 file changed, 2 insertions(+)
Add missing parameter documentation for virtio_dma_buf_attach()
function to fix kernel-doc warnings:
Warning: drivers/virtio/virtio_dma_buf.c:41 function parameter 'dma_buf' not described in 'virtio_dma_buf_attach'
Warning: drivers/virtio/virtio_dma_buf.c:41 function parameter 'attach' not described in 'virtio_dma_buf_attach'
The function documentation was missing descriptions for both the
'dma_buf' and 'attach' parameters. Add proper parameter documentation
following kernel-doc format.
Signed-off-by: WangYuli <wangyuli@uniontech.com>
---
drivers/virtio/virtio_dma_buf.c | 2 ++
1 file changed, 2 insertions(+)
diff --git a/drivers/virtio/virtio_dma_buf.c b/drivers/virtio/virtio_dma_buf.c
index 3fe1d03b0645..95c10632f84a 100644
--- a/drivers/virtio/virtio_dma_buf.c
+++ b/drivers/virtio/virtio_dma_buf.c
@@ -36,6 +36,8 @@ EXPORT_SYMBOL(virtio_dma_buf_export);
/**
* virtio_dma_buf_attach - mandatory attach callback for virtio dma-bufs
+ * @dma_buf: [in] buffer to attach
+ * @attach: [in] attachment structure
*/
int virtio_dma_buf_attach(struct dma_buf *dma_buf,
struct dma_buf_attachment *attach)
--
2.50.0
On Mon, Jun 23, 2025 at 02:52:10PM +0800, WangYuli wrote: > Add missing parameter documentation for virtio_dma_buf_attach() > function to fix kernel-doc warnings: > > Warning: drivers/virtio/virtio_dma_buf.c:41 function parameter 'dma_buf' not described in 'virtio_dma_buf_attach' > Warning: drivers/virtio/virtio_dma_buf.c:41 function parameter 'attach' not described in 'virtio_dma_buf_attach' > > The function documentation was missing descriptions for both the > 'dma_buf' and 'attach' parameters. Add proper parameter documentation > following kernel-doc format. > > Signed-off-by: WangYuli <wangyuli@uniontech.com> Seems to be a subset of: [PATCH v2] virtio: Update kerneldoc in drivers/virtio/virtio_dma_buf.c can you pls review that one? > --- > drivers/virtio/virtio_dma_buf.c | 2 ++ > 1 file changed, 2 insertions(+) > > diff --git a/drivers/virtio/virtio_dma_buf.c b/drivers/virtio/virtio_dma_buf.c > index 3fe1d03b0645..95c10632f84a 100644 > --- a/drivers/virtio/virtio_dma_buf.c > +++ b/drivers/virtio/virtio_dma_buf.c > @@ -36,6 +36,8 @@ EXPORT_SYMBOL(virtio_dma_buf_export); > > /** > * virtio_dma_buf_attach - mandatory attach callback for virtio dma-bufs > + * @dma_buf: [in] buffer to attach > + * @attach: [in] attachment structure > */ > int virtio_dma_buf_attach(struct dma_buf *dma_buf, > struct dma_buf_attachment *attach) > -- > 2.50.0
On Mon, 23 Jun 2025 14:52:10 +0800, WangYuli <wangyuli@uniontech.com> wrote: > Add missing parameter documentation for virtio_dma_buf_attach() > function to fix kernel-doc warnings: > > Warning: drivers/virtio/virtio_dma_buf.c:41 function parameter 'dma_buf' not described in 'virtio_dma_buf_attach' > Warning: drivers/virtio/virtio_dma_buf.c:41 function parameter 'attach' not described in 'virtio_dma_buf_attach' > > The function documentation was missing descriptions for both the > 'dma_buf' and 'attach' parameters. Add proper parameter documentation > following kernel-doc format. > > Signed-off-by: WangYuli <wangyuli@uniontech.com> Reviewed-by: Xuan Zhuo <xuanzhuo@linux.alibaba.com> > --- > drivers/virtio/virtio_dma_buf.c | 2 ++ > 1 file changed, 2 insertions(+) > > diff --git a/drivers/virtio/virtio_dma_buf.c b/drivers/virtio/virtio_dma_buf.c > index 3fe1d03b0645..95c10632f84a 100644 > --- a/drivers/virtio/virtio_dma_buf.c > +++ b/drivers/virtio/virtio_dma_buf.c > @@ -36,6 +36,8 @@ EXPORT_SYMBOL(virtio_dma_buf_export); > > /** > * virtio_dma_buf_attach - mandatory attach callback for virtio dma-bufs > + * @dma_buf: [in] buffer to attach > + * @attach: [in] attachment structure > */ > int virtio_dma_buf_attach(struct dma_buf *dma_buf, > struct dma_buf_attachment *attach) > -- > 2.50.0 >
On Mon, Jun 23, 2025 at 2:55 PM WangYuli <wangyuli@uniontech.com> wrote: > > Add missing parameter documentation for virtio_dma_buf_attach() > function to fix kernel-doc warnings: > > Warning: drivers/virtio/virtio_dma_buf.c:41 function parameter 'dma_buf' not described in 'virtio_dma_buf_attach' > Warning: drivers/virtio/virtio_dma_buf.c:41 function parameter 'attach' not described in 'virtio_dma_buf_attach' > > The function documentation was missing descriptions for both the > 'dma_buf' and 'attach' parameters. Add proper parameter documentation > following kernel-doc format. > > Signed-off-by: WangYuli <wangyuli@uniontech.com> > --- > drivers/virtio/virtio_dma_buf.c | 2 ++ > 1 file changed, 2 insertions(+) > > diff --git a/drivers/virtio/virtio_dma_buf.c b/drivers/virtio/virtio_dma_buf.c > index 3fe1d03b0645..95c10632f84a 100644 > --- a/drivers/virtio/virtio_dma_buf.c > +++ b/drivers/virtio/virtio_dma_buf.c > @@ -36,6 +36,8 @@ EXPORT_SYMBOL(virtio_dma_buf_export); > > /** > * virtio_dma_buf_attach - mandatory attach callback for virtio dma-bufs > + * @dma_buf: [in] buffer to attach > + * @attach: [in] attachment structure > */ > int virtio_dma_buf_attach(struct dma_buf *dma_buf, > struct dma_buf_attachment *attach) > -- > 2.50.0 > Acked-by: Jason Wang <jasowang@redhat.com> Thanks
© 2016 - 2025 Red Hat, Inc.