From patchwork Wed Jun 12 15:00:34 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Sean Paul X-Patchwork-Id: 10990199 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 63E9F76 for ; Wed, 12 Jun 2019 15:00:44 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 52CA4212D8 for ; Wed, 12 Jun 2019 15:00:44 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 4727726256; Wed, 12 Jun 2019 15:00:44 +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=-5.2 required=2.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_DNSWL_MED autolearn=ham version=3.3.1 Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher DHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id EB76F2267B for ; Wed, 12 Jun 2019 15:00:43 +0000 (UTC) Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 152A3894E3; Wed, 12 Jun 2019 15:00:43 +0000 (UTC) X-Original-To: dri-devel@lists.freedesktop.org Delivered-To: dri-devel@lists.freedesktop.org Received: from mail-qt1-x844.google.com (mail-qt1-x844.google.com [IPv6:2607:f8b0:4864:20::844]) by gabe.freedesktop.org (Postfix) with ESMTPS id 270B3894FE for ; Wed, 12 Jun 2019 15:00:42 +0000 (UTC) Received: by mail-qt1-x844.google.com with SMTP id x2so17949051qtr.0 for ; Wed, 12 Jun 2019 08:00:42 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=ZBPf58QxPPuPYue1mt8WshrM290RBAIvY7SGkcWYYFM=; b=ow6b9akIt45sFkn0ONNDR8NZSR6C5/UTNuQ26Ro6onvzoyA4DhX0DXkAFd8L3Kb6fL P21k8FClRD2aov8pXQeEVv2tIj8AY5JjGASxwvwwA0pO2BqFeqij3P3QOgQp8dyHlrIx jJKgoStTjQA2LXQ0GM9phrFlL2GG4ux6TKGynVf5tzaeEOyqddlA7Zmqe5MYu74VnNRg dT66xV8L+/XJ2CPJe4QURFCcjUc6pz6cinFSHODr9NUKkjAmkuBajRXsniYRjht2TY+w BwIXoEEGgcBDZQV2NRJ3DElA99U+cpFK+aFE5OGSm4BfAjCArpLoXWgXZZbgsZnUg13t 4GQA== X-Gm-Message-State: APjAAAW+GGXuAQ5LAroq2daiY7PmfC+k4JDfx3ZunLZiUzCv/4adJimE ATIvkeRra8hCfksOSrWjpOef6ZICq3s= X-Google-Smtp-Source: APXvYqy480RdEP2Sf0SBRIyVT6kktYt2G5K3x4S3ceJgIYKlWXbQ0F7CWrgPbAcOsOOSt1Fsog5hZQ== X-Received: by 2002:ac8:6984:: with SMTP id o4mr70277955qtq.122.1560351640277; Wed, 12 Jun 2019 08:00:40 -0700 (PDT) Received: from rosewood.cam.corp.google.com ([2620:0:1013:11:89c6:2139:5435:371d]) by smtp.gmail.com with ESMTPSA id b5sm4470831qkk.45.2019.06.12.08.00.39 (version=TLS1_3 cipher=AEAD-AES256-GCM-SHA384 bits=256/256); Wed, 12 Jun 2019 08:00:39 -0700 (PDT) From: Sean Paul To: dri-devel@lists.freedesktop.org Subject: [PATCH] drm: Tweak drm_encoder_helper_funcs.enable kerneldoc Date: Wed, 12 Jun 2019 11:00:34 -0400 Message-Id: <20190612150038.194843-1-sean@poorly.run> X-Mailer: git-send-email 2.22.0.rc2.383.gf4fbbf30c2-goog MIME-Version: 1.0 X-Mailman-Original-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=poorly.run; s=google; h=from:to:cc:subject:date:message-id:mime-version :content-transfer-encoding; bh=ZBPf58QxPPuPYue1mt8WshrM290RBAIvY7SGkcWYYFM=; b=Kyb9IEtW/N4o8Q50tTNGdTDMa5Xke7ujpu/CNXfxjhA/HSczmo/PyukpYAn/kTWMx6 lL04M2yNBY1vQjB+fPztsISqTdl5zcvQCm6BtiBW5/Ih6gUg+7DgBk1v1UXK5Kk7ZQx6 Fb0+t6grzUjcBAXoXPC7fQzDzrGEW5R7+SEjHfcgiG1UNCGAnROsqK7hel4es8nqpFkG oMPYbmIwSo9rx4LzlVP1U69Jw5C3KnL5pRqucbyep1fb7EIvSTaEQ4Ba2nwSv53QIdqU zb4s5Ef7CY9WZX2MgI1X0QbsPLFGhaJUnDSRepPG/xOeu8gNfCMZAMk1ZsGIG9RQvBnq B9ew== X-BeenThere: dri-devel@lists.freedesktop.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: Direct Rendering Infrastructure - Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Maxime Ripard , Sean Paul , David Airlie , Sean Paul , Sam Ravnborg Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" X-Virus-Scanned: ClamAV using ClamSMTP From: Sean Paul I copied the kerneldoc for encoder_funcs.atomic_enable from encoder_funcs.enable in a recent patch [1]. Sam rightly pointed out in the review that "for symmetry with" text is awkward [2]. So here's a patch to fix up the source of the awkward language. [1] https://patchwork.freedesktop.org/patch/msgid/20190611160844.257498-2-sean@poorly.run [2] https://patchwork.freedesktop.org/patch/msgid/20190611185352.GA16305@ravnborg.org Suggested-by: Sam Ravnborg Signed-off-by: Sean Paul Reviewed-by: Sam Ravnborg --- include/drm/drm_modeset_helper_vtables.h | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/include/drm/drm_modeset_helper_vtables.h b/include/drm/drm_modeset_helper_vtables.h index f9c94c2a13646..df80131bb10fc 100644 --- a/include/drm/drm_modeset_helper_vtables.h +++ b/include/drm/drm_modeset_helper_vtables.h @@ -719,11 +719,11 @@ struct drm_encoder_helper_funcs { * hooks and call them from CRTC's callback by looping over all encoders * connected to it using for_each_encoder_on_crtc(). * - * This hook is used only by atomic helpers, for symmetry with @disable. - * Atomic drivers don't need to implement it if there's no need to - * enable anything at the encoder level. To ensure that runtime PM handling - * (using either DPMS or the new "ACTIVE" property) works - * @enable must be the inverse of @disable for atomic drivers. + * This hook is only used by atomic helpers, it is the opposite of + * @disable. Atomic drivers don't need to implement it if there's no + * need to enable anything at the encoder level. To ensure that + * runtime PM handling (using either DPMS or the new "ACTIVE" property) + * works @enable must be the inverse of @disable for atomic drivers. */ void (*enable)(struct drm_encoder *encoder);