2020-10-28 06:35:03

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: [PATCH v3 25/32] drm: kernel-doc: add description for a new function parameter

As reported by "make htmldocs":

./drivers/gpu/drm/drm_prime.c:808: warning: Function parameter or member 'dev' not described in 'drm_prime_pages_to_sg'

Add a description for the new parameter.

Fixes: 707d561f77b5 ("drm: allow limiting the scatter list size.")
Signed-off-by: Mauro Carvalho Chehab <[email protected]>
---
drivers/gpu/drm/drm_prime.c | 1 +
1 file changed, 1 insertion(+)

diff --git a/drivers/gpu/drm/drm_prime.c b/drivers/gpu/drm/drm_prime.c
index d6808f678db5..9f955f2010c2 100644
--- a/drivers/gpu/drm/drm_prime.c
+++ b/drivers/gpu/drm/drm_prime.c
@@ -794,6 +794,7 @@ static const struct dma_buf_ops drm_gem_prime_dmabuf_ops = {

/**
* drm_prime_pages_to_sg - converts a page array into an sg list
+ * @dev: DRM device
* @pages: pointer to the array of page pointers to convert
* @nr_pages: length of the page vector
*
--
2.26.2


2020-10-28 06:38:09

by Gerd Hoffmann

[permalink] [raw]
Subject: Re: [PATCH v3 25/32] drm: kernel-doc: add description for a new function parameter

On Tue, Oct 27, 2020 at 10:51:29AM +0100, Mauro Carvalho Chehab wrote:
> As reported by "make htmldocs":
>
> ./drivers/gpu/drm/drm_prime.c:808: warning: Function parameter or member 'dev' not described in 'drm_prime_pages_to_sg'
>
> Add a description for the new parameter.
>
> Fixes: 707d561f77b5 ("drm: allow limiting the scatter list size.")
> Signed-off-by: Mauro Carvalho Chehab <[email protected]>

Acked-by: Gerd Hoffmann <[email protected]>

> ---
> drivers/gpu/drm/drm_prime.c | 1 +
> 1 file changed, 1 insertion(+)
>
> diff --git a/drivers/gpu/drm/drm_prime.c b/drivers/gpu/drm/drm_prime.c
> index d6808f678db5..9f955f2010c2 100644
> --- a/drivers/gpu/drm/drm_prime.c
> +++ b/drivers/gpu/drm/drm_prime.c
> @@ -794,6 +794,7 @@ static const struct dma_buf_ops drm_gem_prime_dmabuf_ops = {
>
> /**
> * drm_prime_pages_to_sg - converts a page array into an sg list
> + * @dev: DRM device
> * @pages: pointer to the array of page pointers to convert
> * @nr_pages: length of the page vector
> *
> --
> 2.26.2
>