From patchwork Tue Aug 25 14:26:03 2015 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Daniel Vetter X-Patchwork-Id: 7071411 Return-Path: X-Original-To: patchwork-dri-devel@patchwork.kernel.org Delivered-To: patchwork-parsemail@patchwork2.web.kernel.org Received: from mail.kernel.org (mail.kernel.org [198.145.29.136]) by patchwork2.web.kernel.org (Postfix) with ESMTP id C1E00C05AC for ; Tue, 25 Aug 2015 14:26:16 +0000 (UTC) Received: from mail.kernel.org (localhost [127.0.0.1]) by mail.kernel.org (Postfix) with ESMTP id D5D58208A6 for ; Tue, 25 Aug 2015 14:26:15 +0000 (UTC) Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) by mail.kernel.org (Postfix) with ESMTP id 031E720831 for ; Tue, 25 Aug 2015 14:26:14 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 64FFC6E27E; Tue, 25 Aug 2015 07:26:13 -0700 (PDT) X-Original-To: dri-devel@lists.freedesktop.org Delivered-To: dri-devel@lists.freedesktop.org Received: from mail-wi0-f180.google.com (mail-wi0-f180.google.com [209.85.212.180]) by gabe.freedesktop.org (Postfix) with ESMTPS id D7D646E225 for ; Tue, 25 Aug 2015 07:26:11 -0700 (PDT) Received: by wicja10 with SMTP id ja10so16756417wic.1 for ; Tue, 25 Aug 2015 07:26:10 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ffwll.ch; s=google; h=from:to:cc:subject:date:message-id; bh=p8ejSe4CvcadW5V+yDWVFgDP38KhepXZHwD/wMxWdoM=; b=hrB/ZiXQ++xFykMDRfD9KKXKywJPyhpmgjZvd0Zl+fCsInlZRQHUDx4l9YGwE61Sk0 q6IjWTq6ldoFAJy9dvEjqycTch3TH26LM7k4fa+5/wtHxD/8dqEf3wJpZo3JuNv2en5a /W0q9V8qpo6q+537TcYPmlMIncqG3VqG+xKj0= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id; bh=p8ejSe4CvcadW5V+yDWVFgDP38KhepXZHwD/wMxWdoM=; b=Za55rcPkE9XknbL8hW+wWzzUtaSlEytJcHCOC55hl4mK9SYI+osG2rkubOCIDF1FKp viaZJwfJ4SiTvKmQkSHohfPuuWsDCx4Vb43Yn1KeAegsMj7+62kNjRDAWFnrbouZS2dM qizPPnNacdc+VTyIekJHFlKbwJ93SsG610Xx1MM2F+rL5ckeKqfS7Si9N2K9kJfhQZbg b2STuSTMjHVSM16Zv4naMGe96cj/QvKtXDX6jDuCUwp9esuz+BNdixGpIlxb0JH80rVQ E7X9ticv1GL5CnNAgajGH1Q+lylNloRpk3BLIAG8HR6ondHcvOtbic3jV1d0T1nuKf8I TaMg== X-Gm-Message-State: ALoCoQkaOksuYFMiozjS7AmpnpXqNX5UtmM0SImQXxZIDw8N736FWyYhgN8t6D6fF4Xaz1EOZSp9 X-Received: by 10.180.105.234 with SMTP id gp10mr5284612wib.40.1440512770366; Tue, 25 Aug 2015 07:26:10 -0700 (PDT) Received: from phenom.ffwll.local (212-51-149-109.fiber7.init7.net. [212.51.149.109]) by smtp.gmail.com with ESMTPSA id r19sm2925916wib.7.2015.08.25.07.26.09 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Tue, 25 Aug 2015 07:26:09 -0700 (PDT) From: Daniel Vetter To: DRI Development Subject: [PATCH] drm/atomic-helper: properly annotate functions in kerneldoc Date: Tue, 25 Aug 2015 16:26:03 +0200 Message-Id: <1440512763-797-1-git-send-email-daniel.vetter@ffwll.ch> X-Mailer: git-send-email 2.5.0 Cc: Daniel Vetter , Intel Graphics Development , Daniel Vetter X-BeenThere: dri-devel@lists.freedesktop.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: Direct Rendering Infrastructure - Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" X-Spam-Status: No, score=-5.4 required=5.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_MED,RP_MATCHES_RCVD,T_DKIM_INVALID,UNPARSEABLE_RELAY autolearn=unavailable version=3.3.1 X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on mail.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP Without the () the markup and more important hyperlinking wont happen. Signed-off-by: Daniel Vetter Acked-by: Laurent Pinchart --- drivers/gpu/drm/drm_atomic_helper.c | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/drivers/gpu/drm/drm_atomic_helper.c b/drivers/gpu/drm/drm_atomic_helper.c index bc9c94e4cbaa..904acf236f36 100644 --- a/drivers/gpu/drm/drm_atomic_helper.c +++ b/drivers/gpu/drm/drm_atomic_helper.c @@ -42,14 +42,14 @@ * add their own additional internal state. * * This library also provides default implementations for the check callback in - * drm_atomic_helper_check and for the commit callback with - * drm_atomic_helper_commit. But the individual stages and callbacks are expose + * drm_atomic_helper_check() and for the commit callback with + * drm_atomic_helper_commit(). But the individual stages and callbacks are expose * to allow drivers to mix and match and e.g. use the plane helpers only * together with a driver private modeset implementation. * * This library also provides implementations for all the legacy driver - * interfaces on top of the atomic interface. See drm_atomic_helper_set_config, - * drm_atomic_helper_disable_plane, drm_atomic_helper_disable_plane and the + * interfaces on top of the atomic interface. See drm_atomic_helper_set_config(), + * drm_atomic_helper_disable_plane(), drm_atomic_helper_disable_plane() and the * various functions to implement set_property callbacks. New drivers must not * implement these functions themselves but must use the provided helpers. */ @@ -1078,7 +1078,7 @@ EXPORT_SYMBOL(drm_atomic_helper_commit); * work item, which allows nice concurrent updates on disjoint sets of crtcs. * * 3. The software state is updated synchronously with - * drm_atomic_helper_swap_state. Doing this under the protection of all modeset + * drm_atomic_helper_swap_state(). Doing this under the protection of all modeset * locks means concurrent callers never see inconsistent state. And doing this * while it's guaranteed that no relevant async worker runs means that async * workers do not need grab any locks. Actually they must not grab locks, for @@ -1351,7 +1351,7 @@ EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes); * * 4. Actually commit the hardware state. * - * 5. Call drm_atomic_helper_cleanup_planes with @state, which since step 3 + * 5. Call drm_atomic_helper_cleanup_planes() with @state, which since step 3 * contains the old state. Also do any other cleanup required with that state. */ void drm_atomic_helper_swap_state(struct drm_device *dev,