diff mbox series

[04/19] gpu: drm: omapdrm: omap_irq: Fix a couple of doc-rot issues

Message ID 20201105144517.1826692-5-lee.jones@linaro.org
State Accepted
Commit 67daa52ddcf91b1857d89e4cde97f2be2f75cf6e
Headers show
Series Rid W=1 warnings from GPU | expand

Commit Message

Lee Jones Nov. 5, 2020, 2:45 p.m. UTC
The API has been updated, but the header was not.

Fixes the following W=1 kernel build warning(s):

 drivers/gpu/drm/omapdrm/omap_irq.c:115: warning: Function parameter or member 'crtc' not described in 'omap_irq_enable_vblank'
 drivers/gpu/drm/omapdrm/omap_irq.c:115: warning: Excess function parameter 'dev' description in 'omap_irq_enable_vblank'
 drivers/gpu/drm/omapdrm/omap_irq.c:115: warning: Excess function parameter 'pipe' description in 'omap_irq_enable_vblank'
 drivers/gpu/drm/omapdrm/omap_irq.c:142: warning: Function parameter or member 'crtc' not described in 'omap_irq_disable_vblank'
 drivers/gpu/drm/omapdrm/omap_irq.c:142: warning: Excess function parameter 'dev' description in 'omap_irq_disable_vblank'
 drivers/gpu/drm/omapdrm/omap_irq.c:142: warning: Excess function parameter 'pipe' description in 'omap_irq_disable_vblank'

Cc: Tomi Valkeinen <tomi.valkeinen@ti.com>
Cc: David Airlie <airlied@linux.ie>
Cc: Daniel Vetter <daniel@ffwll.ch>
Cc: Rob Clark <rob.clark@linaro.org>
Cc: dri-devel@lists.freedesktop.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>

---
 drivers/gpu/drm/omapdrm/omap_irq.c | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

-- 
2.25.1

_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel

Comments

Tomi Valkeinen Nov. 5, 2020, 5:06 p.m. UTC | #1
On 05/11/2020 16:45, Lee Jones wrote:
> The API has been updated, but the header was not.

> 

> Fixes the following W=1 kernel build warning(s):

> 

>  drivers/gpu/drm/omapdrm/omap_irq.c:115: warning: Function parameter or member 'crtc' not described in 'omap_irq_enable_vblank'

>  drivers/gpu/drm/omapdrm/omap_irq.c:115: warning: Excess function parameter 'dev' description in 'omap_irq_enable_vblank'

>  drivers/gpu/drm/omapdrm/omap_irq.c:115: warning: Excess function parameter 'pipe' description in 'omap_irq_enable_vblank'

>  drivers/gpu/drm/omapdrm/omap_irq.c:142: warning: Function parameter or member 'crtc' not described in 'omap_irq_disable_vblank'

>  drivers/gpu/drm/omapdrm/omap_irq.c:142: warning: Excess function parameter 'dev' description in 'omap_irq_disable_vblank'

>  drivers/gpu/drm/omapdrm/omap_irq.c:142: warning: Excess function parameter 'pipe' description in 'omap_irq_disable_vblank'

> 

> Cc: Tomi Valkeinen <tomi.valkeinen@ti.com>

> Cc: David Airlie <airlied@linux.ie>

> Cc: Daniel Vetter <daniel@ffwll.ch>

> Cc: Rob Clark <rob.clark@linaro.org>

> Cc: dri-devel@lists.freedesktop.org

> Signed-off-by: Lee Jones <lee.jones@linaro.org>

> ---

>  drivers/gpu/drm/omapdrm/omap_irq.c | 6 ++----

>  1 file changed, 2 insertions(+), 4 deletions(-)

> 

> diff --git a/drivers/gpu/drm/omapdrm/omap_irq.c b/drivers/gpu/drm/omapdrm/omap_irq.c

> index 382bcdc72ac06..8643871e23a83 100644

> --- a/drivers/gpu/drm/omapdrm/omap_irq.c

> +++ b/drivers/gpu/drm/omapdrm/omap_irq.c

> @@ -100,8 +100,7 @@ int omap_irq_enable_framedone(struct drm_crtc *crtc, bool enable)

>  

>  /**

>   * enable_vblank - enable vblank interrupt events

> - * @dev: DRM device

> - * @pipe: which irq to enable

> + * @crtc: DRM CRTC

>   *

>   * Enable vblank interrupts for @crtc.  If the device doesn't have

>   * a hardware vblank counter, this routine should be a no-op, since

> @@ -131,8 +130,7 @@ int omap_irq_enable_vblank(struct drm_crtc *crtc)

>  

>  /**

>   * disable_vblank - disable vblank interrupt events

> - * @dev: DRM device

> - * @pipe: which irq to enable

> + * @crtc: DRM CRTC

>   *

>   * Disable vblank interrupts for @crtc.  If the device doesn't have

>   * a hardware vblank counter, this routine should be a no-op, since

> 


Hmm, I don't know why we have the doc texts there. These are omapdrm internal functions, and the
text sounds like it was copied from a framework function. I think we can drop the texts here.

But this patch is fine too, and I can drop the text later:

Reviewed-by: Tomi Valkeinen <tomi.valkeinen@ti.com>


 Tomi

-- 
Texas Instruments Finland Oy, Porkkalankatu 22, 00180 Helsinki.
Y-tunnus/Business ID: 0615521-4. Kotipaikka/Domicile: Helsinki
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel
diff mbox series

Patch

diff --git a/drivers/gpu/drm/omapdrm/omap_irq.c b/drivers/gpu/drm/omapdrm/omap_irq.c
index 382bcdc72ac06..8643871e23a83 100644
--- a/drivers/gpu/drm/omapdrm/omap_irq.c
+++ b/drivers/gpu/drm/omapdrm/omap_irq.c
@@ -100,8 +100,7 @@  int omap_irq_enable_framedone(struct drm_crtc *crtc, bool enable)
 
 /**
  * enable_vblank - enable vblank interrupt events
- * @dev: DRM device
- * @pipe: which irq to enable
+ * @crtc: DRM CRTC
  *
  * Enable vblank interrupts for @crtc.  If the device doesn't have
  * a hardware vblank counter, this routine should be a no-op, since
@@ -131,8 +130,7 @@  int omap_irq_enable_vblank(struct drm_crtc *crtc)
 
 /**
  * disable_vblank - disable vblank interrupt events
- * @dev: DRM device
- * @pipe: which irq to enable
+ * @crtc: DRM CRTC
  *
  * Disable vblank interrupts for @crtc.  If the device doesn't have
  * a hardware vblank counter, this routine should be a no-op, since