* [PATCH] virtio: virtio_dma_buf: fix missing parameter documentation
@ 2025-06-23 6:52 WangYuli
2025-06-24 0:41 ` Jason Wang
` (2 more replies)
0 siblings, 3 replies; 4+ messages in thread
From: WangYuli @ 2025-06-23 6:52 UTC (permalink / raw)
To: mst, jasowang, xuanzhuo, eperezma
Cc: virtualization, linux-kernel, zhanjun, niecheng1, guanwentao,
WangYuli
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
^ permalink raw reply related [flat|nested] 4+ messages in thread* Re: [PATCH] virtio: virtio_dma_buf: fix missing parameter documentation
2025-06-23 6:52 [PATCH] virtio: virtio_dma_buf: fix missing parameter documentation WangYuli
@ 2025-06-24 0:41 ` Jason Wang
2025-06-24 8:05 ` Xuan Zhuo
2025-07-16 13:45 ` Michael S. Tsirkin
2 siblings, 0 replies; 4+ messages in thread
From: Jason Wang @ 2025-06-24 0:41 UTC (permalink / raw)
To: WangYuli
Cc: mst, xuanzhuo, eperezma, virtualization, linux-kernel, zhanjun,
niecheng1, guanwentao
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
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] virtio: virtio_dma_buf: fix missing parameter documentation
2025-06-23 6:52 [PATCH] virtio: virtio_dma_buf: fix missing parameter documentation WangYuli
2025-06-24 0:41 ` Jason Wang
@ 2025-06-24 8:05 ` Xuan Zhuo
2025-07-16 13:45 ` Michael S. Tsirkin
2 siblings, 0 replies; 4+ messages in thread
From: Xuan Zhuo @ 2025-06-24 8:05 UTC (permalink / raw)
To: WangYuli
Cc: virtualization, linux-kernel, zhanjun, niecheng1, guanwentao,
WangYuli, mst, jasowang, eperezma
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
>
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] virtio: virtio_dma_buf: fix missing parameter documentation
2025-06-23 6:52 [PATCH] virtio: virtio_dma_buf: fix missing parameter documentation WangYuli
2025-06-24 0:41 ` Jason Wang
2025-06-24 8:05 ` Xuan Zhuo
@ 2025-07-16 13:45 ` Michael S. Tsirkin
2 siblings, 0 replies; 4+ messages in thread
From: Michael S. Tsirkin @ 2025-07-16 13:45 UTC (permalink / raw)
To: WangYuli
Cc: jasowang, xuanzhuo, eperezma, virtualization, linux-kernel,
zhanjun, niecheng1, guanwentao
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
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2025-07-16 13:45 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-06-23 6:52 [PATCH] virtio: virtio_dma_buf: fix missing parameter documentation WangYuli
2025-06-24 0:41 ` Jason Wang
2025-06-24 8:05 ` Xuan Zhuo
2025-07-16 13:45 ` Michael S. Tsirkin
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).