diff mbox series

drm/fb_dma: Fix parameter name in htmldocs

Message ID 20240416090601.237286-1-jfalempe@redhat.com (mailing list archive)
State New, archived
Headers show
Series drm/fb_dma: Fix parameter name in htmldocs | expand

Commit Message

Jocelyn Falempe April 16, 2024, 9:05 a.m. UTC
The parameter name is 'sb' and not 'drm_scanout_buffer'.
It fixes the following warnings:

drivers/gpu/drm/drm_fb_dma_helper.c:166: warning: Excess function parameter 'drm_scanout_buffer' description in 'drm_fb_dma_get_scanout_buffer'
drivers/gpu/drm/drm_fb_dma_helper.c:166: warning: Function parameter or struct member 'sb' not described in 'drm_fb_dma_get_scanout_buffer'
drivers/gpu/drm/drm_fb_dma_helper.c:166: warning: Excess function parameter 'drm_scanout_buffer' description in 'drm_fb_dma_get_scanout_buffer'

Fixes: 879b3b6511fe ("drm/fb_dma: Add generic get_scanout_buffer() for drm_panic")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Jocelyn Falempe <jfalempe@redhat.com>
---
 drivers/gpu/drm/drm_fb_dma_helper.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)


base-commit: 7b0062036c3b71b4a69e244ecf0502c06c4cf5f0

Comments

Thomas Zimmermann April 16, 2024, 12:12 p.m. UTC | #1
Hi

Am 16.04.24 um 11:05 schrieb Jocelyn Falempe:
> The parameter name is 'sb' and not 'drm_scanout_buffer'.
> It fixes the following warnings:
>
> drivers/gpu/drm/drm_fb_dma_helper.c:166: warning: Excess function parameter 'drm_scanout_buffer' description in 'drm_fb_dma_get_scanout_buffer'
> drivers/gpu/drm/drm_fb_dma_helper.c:166: warning: Function parameter or struct member 'sb' not described in 'drm_fb_dma_get_scanout_buffer'
> drivers/gpu/drm/drm_fb_dma_helper.c:166: warning: Excess function parameter 'drm_scanout_buffer' description in 'drm_fb_dma_get_scanout_buffer'
>
> Fixes: 879b3b6511fe ("drm/fb_dma: Add generic get_scanout_buffer() for drm_panic")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Signed-off-by: Jocelyn Falempe <jfalempe@redhat.com>

Reviewed-by: Thomas Zimmermann <tzimmermann@suse.de>

Best regards
Thomas

> ---
>   drivers/gpu/drm/drm_fb_dma_helper.c | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/gpu/drm/drm_fb_dma_helper.c b/drivers/gpu/drm/drm_fb_dma_helper.c
> index c79b5078303f..96e5ab960f12 100644
> --- a/drivers/gpu/drm/drm_fb_dma_helper.c
> +++ b/drivers/gpu/drm/drm_fb_dma_helper.c
> @@ -153,7 +153,7 @@ EXPORT_SYMBOL_GPL(drm_fb_dma_sync_non_coherent);
>   /**
>    * drm_fb_dma_get_scanout_buffer - Provide a scanout buffer in case of panic
>    * @plane: DRM primary plane
> - * @drm_scanout_buffer: scanout buffer for the panic handler
> + * @sb: scanout buffer for the panic handler
>    * Returns: 0 or negative error code
>    *
>    * Generic get_scanout_buffer() implementation, for drivers that uses the
>
> base-commit: 7b0062036c3b71b4a69e244ecf0502c06c4cf5f0
Jocelyn Falempe April 16, 2024, 3:03 p.m. UTC | #2
On 16/04/2024 14:12, Thomas Zimmermann wrote:
> Hi
> 
> Am 16.04.24 um 11:05 schrieb Jocelyn Falempe:
>> The parameter name is 'sb' and not 'drm_scanout_buffer'.
>> It fixes the following warnings:
>>
>> drivers/gpu/drm/drm_fb_dma_helper.c:166: warning: Excess function 
>> parameter 'drm_scanout_buffer' description in 
>> 'drm_fb_dma_get_scanout_buffer'
>> drivers/gpu/drm/drm_fb_dma_helper.c:166: warning: Function parameter 
>> or struct member 'sb' not described in 'drm_fb_dma_get_scanout_buffer'
>> drivers/gpu/drm/drm_fb_dma_helper.c:166: warning: Excess function 
>> parameter 'drm_scanout_buffer' description in 
>> 'drm_fb_dma_get_scanout_buffer'
>>
>> Fixes: 879b3b6511fe ("drm/fb_dma: Add generic get_scanout_buffer() for 
>> drm_panic")
>> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
>> Signed-off-by: Jocelyn Falempe <jfalempe@redhat.com>
> 
> Reviewed-by: Thomas Zimmermann <tzimmermann@suse.de>

pushed to drm-misc-next

Thanks,
diff mbox series

Patch

diff --git a/drivers/gpu/drm/drm_fb_dma_helper.c b/drivers/gpu/drm/drm_fb_dma_helper.c
index c79b5078303f..96e5ab960f12 100644
--- a/drivers/gpu/drm/drm_fb_dma_helper.c
+++ b/drivers/gpu/drm/drm_fb_dma_helper.c
@@ -153,7 +153,7 @@  EXPORT_SYMBOL_GPL(drm_fb_dma_sync_non_coherent);
 /**
  * drm_fb_dma_get_scanout_buffer - Provide a scanout buffer in case of panic
  * @plane: DRM primary plane
- * @drm_scanout_buffer: scanout buffer for the panic handler
+ * @sb: scanout buffer for the panic handler
  * Returns: 0 or negative error code
  *
  * Generic get_scanout_buffer() implementation, for drivers that uses the