Skip to contentSkip to conversation

drm/fb_dma: Fix parameter name in htmldocs

PATCH In review Jocelyn Falempe 2 participants 3 messages Apr 16, 2024

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 drm/fb_dma: Fix parameter name in htmldocs

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")
---
 drivers/gpu/drm/drm_fb_dma_helper.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/gpu/drm/drm_fb_dma_helper.c +1 -1
index c79b5078303f..96e5ab960f12 100644
@@ -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

Signature · 1 line
2.44.0
maintainer Reviewed-by on v1 1/1
#1 lore raw

Hi

Am 16.04.24 um 11:05 schrieb Jocelyn Falempe:

Quoted 10 lines

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")

Best regards
Thomas

Quoted 19 lines
---
  drivers/gpu/drm/drm_fb_dma_helper.c | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
drivers/gpu/drm/drm_fb_dma_helper.c +1 -1
index c79b5078303f..96e5ab960f12 100644
@@ -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

Signature · 7 lines
--
Thomas Zimmermann
Graphics Driver Developer
SUSE Software Solutions Germany GmbH
Frankenstrasse 146, 90461 Nuernberg, Germany
GF: Ivo Totev, Andrew Myers, Andrew McDonald, Boudien Moerman
HRB 36809 (AG Nuernberg)
author Applied
#2 lore raw
Quoted 10 lines · Thomas Zimmermann

Hi

Am 16.04.24 um 11:05 schrieb Jocelyn Falempe:

Quoted 7 lines

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'

Quoted 5 lines
Quoted 3 lines
Fixes 879b3b6511fe ("drm/fb_dma: Add generic get_scanout_buffer() for drm_panic")

pushed to drm-misc-next

Thanks,

Signature · 1 line
Jocelyn
Quoted 24 lines

Best regards
Thomas

Quoted 19 lines

---
  drivers/gpu/drm/drm_fb_dma_helper.c | 2 +-

  1 file changed, 1 insertion(+), 1 deletion(-)
drivers/gpu/drm/drm_fb_dma_helper.c +1 -1
index c79b5078303f..96e5ab960f12 100644
@@ -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