Skip to contentSkip to conversation

drm: add drm_format_helper.c to kerneldoc

PATCH In review Gerd Hoffmann 2 participants 2 messages Apr 16, 2019

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

PATCH 1/1 drm: add drm_format_helper.c to kerneldoc

Also drop the dstclip parameter sphinx has warned about (leftolver from an earlier patch version).

---
 drivers/gpu/drm/drm_format_helper.c   | 1 -
 Documentation/gpu/drm-kms-helpers.rst | 6 ++++++
 2 files changed, 6 insertions(+), 1 deletion(-)
drivers/gpu/drm/drm_format_helper.c +0 -1
index da388012df2a..a18da35145b7 100644
@@ -235,7 +235,6 @@ static void drm_fb_xrgb8888_to_rgb888_line(u8 *dbuf, u32 *sbuf,
  * @vaddr: XRGB8888 source buffer
  * @fb: DRM framebuffer
  * @clip: Clip rectangle area to copy
- * @dstclip: Clip destination too.
  *
  * Drivers can use this function for RGB888 devices that don't natively
  * support XRGB8888.
Documentation/gpu/drm-kms-helpers.rst +6 -0
index 58b375e47615..14102ae035dc 100644
@@ -107,6 +107,12 @@ fbdev Helper Functions Reference
 .. kernel-doc:: drivers/gpu/drm/drm_fb_helper.c
    :export:
 
+format Helper Functions Reference
+=================================
+
+.. kernel-doc:: drivers/gpu/drm/drm_format_helper.c
+   :export:
+
 Framebuffer CMA Helper Functions Reference
 ==========================================
 
Signature · 1 line
2.18.1
Acked-by on v1 1/1
#1 lore raw
Quoted 4 lines · Gerd Hoffmann

Also drop the dstclip parameter sphinx has warned about (leftolver from an earlier patch version).

Assuming it all builds cleanly and all the links work and no warnings from sphinx:

Quoted 37 lines
---
 drivers/gpu/drm/drm_format_helper.c   | 1 -
 Documentation/gpu/drm-kms-helpers.rst | 6 ++++++
 2 files changed, 6 insertions(+), 1 deletion(-)
drivers/gpu/drm/drm_format_helper.c +0 -1
index da388012df2a..a18da35145b7 100644
@@ -235,7 +235,6 @@ static void drm_fb_xrgb8888_to_rgb888_line(u8 *dbuf, u32 *sbuf,
  * @vaddr: XRGB8888 source buffer
  * @fb: DRM framebuffer
  * @clip: Clip rectangle area to copy
- * @dstclip: Clip destination too.
  *
  * Drivers can use this function for RGB888 devices that don't natively
  * support XRGB8888.
Documentation/gpu/drm-kms-helpers.rst +6 -0
index 58b375e47615..14102ae035dc 100644
@@ -107,6 +107,12 @@ fbdev Helper Functions Reference
 .. kernel-doc:: drivers/gpu/drm/drm_fb_helper.c
    :export:
 
+format Helper Functions Reference
+=================================
+
+.. kernel-doc:: drivers/gpu/drm/drm_format_helper.c
+   :export:
+
 Framebuffer CMA Helper Functions Reference
 ==========================================
 
Signature · 1 line
2.18.1
Signature · 3 lines
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch