| Message ID | 20190612150038.194843-1-sean@poorly.run (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | drm: Tweak drm_encoder_helper_funcs.enable kerneldoc | expand |
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
On Wed, Jun 12, 2019 at 05:09:27PM +0200, Sam Ravnborg wrote: > 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> Applied to drm-misc-next with your R-b, thanks! Sean > > > --- > > 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
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);