dri-devel Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: Thierry Reding <thierry.reding@gmail.com>
To: dri-devel@lists.freedesktop.org
Cc: linux-samsung-soc@vger.kernel.org,
	Daniel Vetter <daniel.vetter@ffwll.ch>,
	Benjamin Gaignard <benjamin.gaignard@linaro.org>,
	Mark Yao <mark.yao@rock-chips.com>
Subject: [PATCH 11/13] drm/irq: Document return values more consistently
Date: Tue, 16 Dec 2014 17:53:33 +0100	[thread overview]
Message-ID: <1418748815-15434-11-git-send-email-thierry.reding@gmail.com> (raw)
In-Reply-To: <1418748815-15434-1-git-send-email-thierry.reding@gmail.com>

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

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

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

  parent reply	other threads:[~2014-12-16 16:54 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-12-16 16:53 [PATCH 01/13] drm/irq: Remove negative CRTC index special-case Thierry Reding
2014-12-16 16:53 ` [PATCH 02/13] drm/bochs: Store correct CRTC index in events Thierry Reding
2014-12-16 16:53 ` [PATCH 03/13] drm/exynos: " Thierry Reding
2014-12-16 16:53 ` [PATCH 04/13] drm/imx: Make pipe number unsigned Thierry Reding
2014-12-16 17:30   ` Philipp Zabel
2014-12-16 16:53 ` [PATCH 05/13] drm/imx: Store correct CRTC index in events Thierry Reding
2014-12-16 17:36   ` Philipp Zabel
2014-12-16 16:53 ` [PATCH 06/13] drm/rockchip: " Thierry Reding
2014-12-16 16:53 ` [PATCH 07/13] drm/sti: " Thierry Reding
2014-12-16 16:53 ` [PATCH 08/13] drm/irq: Check for valid VBLANK before dereference Thierry Reding
2014-12-17  3:11   ` Michel Dänzer
2014-12-16 16:53 ` [PATCH 09/13] drm/irq: Make pipe unsigned and name consistent Thierry Reding
2014-12-16 17:53   ` Daniel Vetter
2014-12-16 16:53 ` [PATCH 10/13] drm/irq: Add drm_crtc_vblank_count_and_time() Thierry Reding
2014-12-16 16:53 ` Thierry Reding [this message]
2014-12-16 18:02   ` [PATCH 11/13] drm/irq: Document return values more consistently Daniel Vetter
2014-12-16 16:53 ` [PATCH 12/13] drm/irq: Expel legacy API Thierry Reding
2014-12-16 17:59   ` Daniel Vetter
2014-12-16 18:00     ` Daniel Vetter
2014-12-16 16:53 ` [PATCH 13/13] drm/irq: Move some prototypes to drm_crtc.h Thierry Reding
  -- strict thread matches above, loose matches on Subject: below --
2015-08-12 15:00 [PATCH 01/13] drm/gma500: Sanity-check pipe index Thierry Reding
2015-08-12 15:00 ` [PATCH 11/13] drm/irq: Document return values more consistently Thierry Reding

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1418748815-15434-11-git-send-email-thierry.reding@gmail.com \
    --to=thierry.reding@gmail.com \
    --cc=benjamin.gaignard@linaro.org \
    --cc=daniel.vetter@ffwll.ch \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=linux-samsung-soc@vger.kernel.org \
    --cc=mark.yao@rock-chips.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox