drm/fb_dma: Fix parameter name in htmldocs

Jocelyn Falempe · Jocelyn Falempe · commit 5289ed190643 · 2024-04-16T16:59:30.000+02:00
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: 879b3b6 ("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> Link: https://patchwork.freedesktop.org/patch/msgid/20240416090601.237286-1-jfalempe@redhat.com
diff --git 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

Original file line number	Diff line number	Diff line change
`@@ -153,7 +153,7 @@ EXPORT_SYMBOL_GPL(drm_fb_dma_sync_non_coherent);`
`153`	`153`	`/**`
`154`	`154`	`* drm_fb_dma_get_scanout_buffer - Provide a scanout buffer in case of panic`
`155`	`155`	`* @plane: DRM primary plane`
`156`		`- * @drm_scanout_buffer: scanout buffer for the panic handler`
	`156`	`+ * @sb: scanout buffer for the panic handler`
`157`	`157`	`* Returns: 0 or negative error code`
`158`	`158`	`*`
`159`	`159`	`* Generic get_scanout_buffer() implementation, for drivers that uses the`