From patchwork Fri Jul 15 19:48:05 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Daniel Vetter X-Patchwork-Id: 9232523 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id 4448360868 for ; Fri, 15 Jul 2016 19:48:48 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 38CF02621F for ; Fri, 15 Jul 2016 19:48:48 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 2D53526D08; Fri, 15 Jul 2016 19:48:48 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-4.1 required=2.0 tests=BAYES_00,DKIM_SIGNED, RCVD_IN_DNSWL_MED,T_DKIM_INVALID autolearn=ham version=3.3.1 Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id E49142621F for ; Fri, 15 Jul 2016 19:48:47 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 535C26EAC1; Fri, 15 Jul 2016 19:48:31 +0000 (UTC) X-Original-To: dri-devel@lists.freedesktop.org Delivered-To: dri-devel@lists.freedesktop.org Received: from mail-wm0-x244.google.com (mail-wm0-x244.google.com [IPv6:2a00:1450:400c:c09::244]) by gabe.freedesktop.org (Postfix) with ESMTPS id 6E4416EAB8 for ; Fri, 15 Jul 2016 19:48:27 +0000 (UTC) Received: by mail-wm0-x244.google.com with SMTP id o80so3439390wme.0 for ; Fri, 15 Jul 2016 12:48:27 -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:in-reply-to:references; bh=MAJsnX+6lVGePUtNqJSzbsPihjwFClpzoiW1IQrEDmU=; b=FiMRp7HBXOIdtrcb8Pn1MWhWCEz9gMGcSAiYT526do214l6Ni07ZN2hqu7jrSttAwF NqQNkPmvG8mhS1r25Nyb5B0JKlIdCFxe9QfCXGmyEapc5Ixj5uiRzgoXJj4GdWvjZSbq GqxcBg7cbqfG0prImoq1n2kGMqRz5Uu7c9voI= 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:in-reply-to :references; bh=MAJsnX+6lVGePUtNqJSzbsPihjwFClpzoiW1IQrEDmU=; b=HySmQSqIvHdPz211Ylx5p35by+MdJI3uTpcf91KZ7JLPefGEMma2zJX9bNryFa2wQm ZPh1nzR12dc9vMwBPpG8v5zt3zuamAOX2yMJ0rExs2a0uGlixsgCWLUH64RZN5TtZPDn Xo3TziFs7CaFtJiGzU9v4j7nUz00GlSg4vHy9tvtlc/xc8Uq2JGw3YYZBNUAX9+fDPYY uTdsH1HvEjqYZk5bgkQMGgWSYLM2R9k48KlH4uE/sZA2PuSa8HASJ7Ul9x9Vb0mf4ZD8 Y7COAsHT69zNzRUW64BmTpKIIfoQs47N36EXIeeLpusymrFoEbL7UhIEPqCKRY8ZIWhb eizQ== X-Gm-Message-State: ALyK8tK7hSu8LmP3S1jmIVdXErIq0H0efyyvzhA/qz/3xwt3DT93ofhh56c60yOFVDkccw== X-Received: by 10.194.169.33 with SMTP id ab1mr2396839wjc.151.1468612105158; Fri, 15 Jul 2016 12:48:25 -0700 (PDT) Received: from phenom.ffwll.local ([2a02:168:56b5:0:ac27:b86c:7764:9429]) by smtp.gmail.com with ESMTPSA id bf3sm2256810wjb.32.2016.07.15.12.48.24 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Fri, 15 Jul 2016 12:48:24 -0700 (PDT) From: Daniel Vetter To: DRI Development Subject: [PATCH 08/11] drm/i915: Fixup kerneldoc code snippets in intel_uncore.c Date: Fri, 15 Jul 2016 21:48:05 +0200 Message-Id: <1468612088-9721-8-git-send-email-daniel.vetter@ffwll.ch> X-Mailer: git-send-email 2.8.1 In-Reply-To: <1468612088-9721-1-git-send-email-daniel.vetter@ffwll.ch> References: <1468612088-9721-1-git-send-email-daniel.vetter@ffwll.ch> Cc: Daniel Vetter , Intel Graphics Development 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-Virus-Scanned: ClamAV using ClamSMTP We need :: before, blank lines around and indentation with 4 _additional_ spaces to make it work. Also, don't use @param in code snippets, it results in confusion. Signed-off-by: Daniel Vetter --- drivers/gpu/drm/i915/intel_uncore.c | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/drivers/gpu/drm/i915/intel_uncore.c b/drivers/gpu/drm/i915/intel_uncore.c index eeb4cbce19ff..43f833901b8e 100644 --- a/drivers/gpu/drm/i915/intel_uncore.c +++ b/drivers/gpu/drm/i915/intel_uncore.c @@ -1618,8 +1618,10 @@ static int gen6_reset_engines(struct drm_i915_private *dev_priv, * @timeout_ms: timeout in millisecond * * This routine waits until the target register @reg contains the expected - * @value after applying the @mask, i.e. it waits until - * (I915_READ_FW(@reg) & @mask) == @value + * @value after applying the @mask, i.e. it waits until :: + * + * (I915_READ_FW(reg) & mask) == value + * * Otherwise, the wait will timeout after @timeout_ms milliseconds. * * Note that this routine assumes the caller holds forcewake asserted, it is @@ -1652,8 +1654,10 @@ int intel_wait_for_register_fw(struct drm_i915_private *dev_priv, * @timeout_ms: timeout in millisecond * * This routine waits until the target register @reg contains the expected - * @value after applying the @mask, i.e. it waits until - * (I915_READ(@reg) & @mask) == @value + * @value after applying the @mask, i.e. it waits until :: + * + * (I915_READ(reg) & mask) == value + * * Otherwise, the wait will timeout after @timeout_ms milliseconds. * * Returns 0 if the register matches the desired condition, or -ETIMEOUT.