[PATCH 0/4] vc4 RST documentation

From	Eric Anholt <eric@anholt.net>
Newsgroups	linux.kernel
Subject	[PATCH 0/4] vc4 RST documentation
Date	2017-02-27 23:40 +0100
Message-ID	<tfAfo-2lV-5@gated-at.bofh.it> (permalink)
Organization	linux.* mail to news gateway

Show all headers | View raw

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.

 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

Back to linux.kernel | Previous | Next — Next in thread | Find similar | Unroll thread

Thread

[PATCH 0/4] vc4 RST documentation Eric Anholt <eric@anholt.net> - 2017-02-27 23:40 +0100
  [PATCH 3/4] drm/vc4: Extend and edit documentation for output from the RST Eric Anholt <eric@anholt.net> - 2017-02-27 23:40 +0100
  [PATCH 2/4] drm/vc4: Add RST to bring together vc4 kerneldoc. Eric Anholt <eric@anholt.net> - 2017-02-27 23:40 +0100
  [PATCH 1/4] drm/vc4: Convert existing documentation to actual kerneldoc. Eric Anholt <eric@anholt.net> - 2017-02-27 23:40 +0100
  Re: [PATCH 0/4] vc4 RST documentation Daniel Vetter <daniel@ffwll.ch> - 2017-02-28 10:00 +0100
    Re: [PATCH 0/4] vc4 RST documentation Eric Anholt <eric@anholt.net> - 2017-02-28 23:50 +0100

csiph-web