dri-devel Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: Sam Ravnborg <sam@ravnborg.org>
To: Sean Paul <sean@poorly.run>
Cc: Maxime Ripard <maxime.ripard@bootlin.com>,
	dri-devel@lists.freedesktop.org, David Airlie <airlied@linux.ie>,
	Sean Paul <seanpaul@chromium.org>
Subject: Re: [PATCH] drm: Tweak drm_encoder_helper_funcs.enable kerneldoc
Date: Wed, 12 Jun 2019 17:09:27 +0200	[thread overview]
Message-ID: <20190612150927.GA5030@ravnborg.org> (raw)
In-Reply-To: <20190612150038.194843-1-sean@poorly.run>

On Wed, Jun 12, 2019 at 11:00:34AM -0400, Sean Paul wrote:
> From: Sean Paul <seanpaul@chromium.org>
> 
> 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.

Looks good.
> 
> [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 <sam@ravnborg.org>
> Signed-off-by: Sean Paul <seanpaul@chromium.org>
Reviewed-by: Sam Ravnborg <sam@ravnborg.org>

> ---
>  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);
>  
> -- 
> Sean Paul, Software Engineer, Google / Chromium OS
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel

  reply	other threads:[~2019-06-12 15:09 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-06-12 15:00 [PATCH] drm: Tweak drm_encoder_helper_funcs.enable kerneldoc Sean Paul
2019-06-12 15:09 ` Sam Ravnborg [this message]
2019-06-12 15:46   ` Sean Paul

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=20190612150927.GA5030@ravnborg.org \
    --to=sam@ravnborg.org \
    --cc=airlied@linux.ie \
    --cc=dri-devel@lists.freedesktop.org \
    --cc=maxime.ripard@bootlin.com \
    --cc=sean@poorly.run \
    --cc=seanpaul@chromium.org \
    /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