Re: [PATCH 4/4] drm/panel: Add helper for simple panel connector

Daniel Vetter
2016-05-06T14:07:06Z

On Fri, May 06, 2016 at 04:01:37PM +0200, Thierry Reding wrote:
> On Fri, May 06, 2016 at 03:39:53PM +0200, Noralf Trønnes wrote:
> >
> > Den 05.05.2016 19:03, skrev Daniel Vetter:
> > > On Thu, May 05, 2016 at 03:24:34PM +0200, Noralf Trønnes wrote:
> > > > Add function to create a simple connector for a panel.
> > > >
> > > > Signed-off-by: Noralf Trønnes <noralf@tronnes.org>
> > > Like in the previous patch please also add a new section for the panel
> > > helpers to gpu.tmpl. I don't think this needs an overview section, it's so
> > > simple. But adding some cross references from the drm_panel.c kerneldoc to
> > > this and back would be real good.
> >
> > drm_panel.c doesn't have any documentation and the header file has only
> > the drm_panel_funcs struct documented, not hooked up to gpu.tmpl.
> >
> > I can make a patch documenting the functions, it looks fairly straight
> > forward, but I have no idea what to put in the DOC: section, except an
> > xref to this helper :-)
>
> Maybe now is a good time for me to post the below. I really should've
> sent this out ages ago, sorry.
>
> Thierry
> --- >8 ---
> From 77057510413f8ca52d37da883afeabb13031ec63 Mon Sep 17 00:00:00 2001
> From: Thierry Reding <treding@nvidia.com>
> Date: Tue, 4 Nov 2014 15:23:10 +0100
> Subject: [PATCH] drm/panel: Flesh out kerneldoc
>
> Write more complete kerneldoc comments for the DRM panel API and
> integrate the helpers in the DRM DocBook reference.
>
> Signed-off-by: Thierry Reding <treding@nvidia.com>

Applied to drm-msic, thanks.

> ---
> Documentation/DocBook/gpu.tmpl | 12 ++++++---
> drivers/gpu/drm/drm_panel.c | 61 ++++++++++++++++++++++++++++++++++++++++++
> include/drm/drm_panel.h | 59 ++++++++++++++++++++++++++++++++++++++++
> 3 files changed, 129 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/DocBook/gpu.tmpl b/Documentation/DocBook/gpu.tmpl
> index 1464fb2f3c46..fb4ad6945a97 100644
> --- a/Documentation/DocBook/gpu.tmpl
> +++ b/Documentation/DocBook/gpu.tmpl
> @@ -1671,17 +1671,23 @@ void intel_crt_init(struct drm_device *dev)
> !Pdrivers/gpu/drm/drm_crtc.c Tile group
> </sect2>
> <sect2>
> - Bridges
> + Bridges
> <sect3>
> - Overview
> + Overview
> !Pdrivers/gpu/drm/drm_bridge.c overview
> </sect3>
> <sect3>
> - Default bridge callback sequence
> + Default bridge callback sequence
> !Pdrivers/gpu/drm/drm_bridge.c bridge callbacks
> </sect3>
> !Edrivers/gpu/drm/drm_bridge.c
> </sect2>
> + <sect2>
> + Panel Helper Reference
> +!Iinclude/drm/drm_panel.h
> +!Edrivers/gpu/drm/drm_panel.c
> +!Pdrivers/gpu/drm/drm_panel.c drm panel
> + </sect2>

Hm, since you call this a helper, and we already have a Kconfig for it I
guess would make sense to put Noralf's connector-for-panel helper in there
too?
-Daniel
--
Daniel Vetter
Software Engineer, Intel Corporation