diff mbox

[11/13] drm/irq: Document return values more consistently

Message ID 1418748815-15434-11-git-send-email-thierry.reding@gmail.com (mailing list archive)
State New, archived
Headers show

Commit Message

Thierry Reding Dec. 16, 2014, 4:53 p.m. UTC 
From: Thierry Reding <treding@nvidia.com>

Some of the functions are documented inconsistently. Add Returns:
sections where missing and use consistent style to describe the return
value.

Signed-off-by: Thierry Reding <treding@nvidia.com>
---
 drivers/gpu/drm/drm_irq.c | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

Comments

Daniel Vetter Dec. 16, 2014, 6:02 p.m. UTC | #1 
On Tue, Dec 16, 2014 at 05:53:33PM +0100, Thierry Reding wrote:
> From: Thierry Reding <treding@nvidia.com>
> 
> Some of the functions are documented inconsistently. Add Returns:
> sections where missing and use consistent style to describe the return
> value.
> 
> Signed-off-by: Thierry Reding <treding@nvidia.com>

With the comment in patch 9 addressed patches 1-11 are

Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch>

> ---
>  drivers/gpu/drm/drm_irq.c | 7 +++++--
>  1 file changed, 5 insertions(+), 2 deletions(-)
> 
> diff --git a/drivers/gpu/drm/drm_irq.c b/drivers/gpu/drm/drm_irq.c
> index b34900a8e172..ef5d993f06ee 100644
> --- a/drivers/gpu/drm/drm_irq.c
> +++ b/drivers/gpu/drm/drm_irq.c
> @@ -991,6 +991,9 @@ EXPORT_SYMBOL(drm_crtc_send_vblank_event);
>   * drm_vblank_enable - enable the vblank interrupt on a CRTC
>   * @dev: DRM device
>   * @pipe: CRTC index
> + *
> + * Returns:
> + * Zero on success or a negative error code on failure.
>   */
>  static int drm_vblank_enable(struct drm_device *dev, unsigned int pipe)
>  {
> @@ -1035,7 +1038,7 @@ static int drm_vblank_enable(struct drm_device *dev, unsigned int pipe)
>   * This is the legacy version of drm_crtc_vblank_get().
>   *
>   * Returns:
> - * Zero on success, nonzero on failure.
> + * Zero on success or a negative error code on failure.
>   */
>  int drm_vblank_get(struct drm_device *dev, unsigned int pipe)
>  {
> @@ -1072,7 +1075,7 @@ EXPORT_SYMBOL(drm_vblank_get);
>   * This is the native kms version of drm_vblank_off().
>   *
>   * Returns:
> - * Zero on success, nonzero on failure.
> + * Zero on success or a negative error code on failure.
>   */
>  int drm_crtc_vblank_get(struct drm_crtc *crtc)
>  {
> -- 
> 2.1.3
>
diff mbox

Patch

diff --git a/drivers/gpu/drm/drm_irq.c b/drivers/gpu/drm/drm_irq.c
index b34900a8e172..ef5d993f06ee 100644
--- a/drivers/gpu/drm/drm_irq.c
+++ b/drivers/gpu/drm/drm_irq.c
@@ -991,6 +991,9 @@  EXPORT_SYMBOL(drm_crtc_send_vblank_event);
  * drm_vblank_enable - enable the vblank interrupt on a CRTC
  * @dev: DRM device
  * @pipe: CRTC index
+ *
+ * Returns:
+ * Zero on success or a negative error code on failure.
  */
 static int drm_vblank_enable(struct drm_device *dev, unsigned int pipe)
 {
@@ -1035,7 +1038,7 @@  static int drm_vblank_enable(struct drm_device *dev, unsigned int pipe)
  * This is the legacy version of drm_crtc_vblank_get().
  *
  * Returns:
- * Zero on success, nonzero on failure.
+ * Zero on success or a negative error code on failure.
  */
 int drm_vblank_get(struct drm_device *dev, unsigned int pipe)
 {
@@ -1072,7 +1075,7 @@  EXPORT_SYMBOL(drm_vblank_get);
  * This is the native kms version of drm_vblank_off().
  *
  * Returns:
- * Zero on success, nonzero on failure.
+ * Zero on success or a negative error code on failure.
  */
 int drm_crtc_vblank_get(struct drm_crtc *crtc)
 {