Re: [PATCH 0/4] vc4 RST documentation

From: Daniel Vetter
Date: Tue Feb 28 2017 - 03:58:30 EST


On Mon, Feb 27, 2017 at 12:11:40PM -0800, Eric Anholt wrote:
> danvet asked me a while ago to try generating documentation with the
> new RST-based infrastructure. I had a couple of hours to do some
> editing, so here it is.
>
> So far I'm not including any kerneldoc for functions. I don't think I
> have enough documentation coverage yet to make it useful to start
> including the current ones in the output.
>
> Eric Anholt (4):
> drm/vc4: Convert existing documentation to actual kerneldoc.
> drm/vc4: Add RST to bring together vc4 kerneldoc.
> drm/vc4: Extend and edit documentation for output from the RST
> drm/vc4: Add a paragraph at the top of vc4 docs introducing what it
> is.

Wooohooooo, this is sweet! I know it's just a rough just, but I think i915
is even rougher, and we just need to get going somewhere. Really awesome.
On the series:

Acked-by: Daniel Vetter <daniel.vetter@xxxxxxxx>
>
> Documentation/gpu/index.rst | 1 +
> Documentation/gpu/vc4.rst | 89 ++++++++++++++++++++++++++++++
> drivers/gpu/drm/vc4/vc4_bo.c | 5 +-
> drivers/gpu/drm/vc4/vc4_crtc.c | 7 ++-
> drivers/gpu/drm/vc4/vc4_dpi.c | 3 +-
> drivers/gpu/drm/vc4/vc4_drv.c | 16 ++++++
> drivers/gpu/drm/vc4/vc4_dsi.c | 5 +-
> drivers/gpu/drm/vc4/vc4_gem.c | 26 +++++++--
> drivers/gpu/drm/vc4/vc4_hdmi.c | 23 +++++++-
> drivers/gpu/drm/vc4/vc4_hvs.c | 12 ++--
> drivers/gpu/drm/vc4/vc4_irq.c | 3 +-
> drivers/gpu/drm/vc4/vc4_render_cl.c | 4 ++
> drivers/gpu/drm/vc4/vc4_validate.c | 34 +++++++-----
> drivers/gpu/drm/vc4/vc4_validate_shaders.c | 21 ++++---
> drivers/gpu/drm/vc4/vc4_vec.c | 6 ++
> 15 files changed, 212 insertions(+), 43 deletions(-)
> create mode 100644 Documentation/gpu/vc4.rst
>
> --
> 2.11.0
>
> _______________________________________________
> dri-devel mailing list
> dri-devel@xxxxxxxxxxxxxxxxxxxxx
> https://lists.freedesktop.org/mailman/listinfo/dri-devel

--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch