[PATCH 00/34] drm: moar kerneldoc and cleanups

[Alex Deucher]

On Tue, Mar 11, 2014 at 6:29 AM, Daniel Vetter <daniel.vetter at ffwll.ch> wrote:
> Hi all,
>
> So this is the 2nd iteration of my kerneldoc polish for 3.14. I should have
> taken in all feedback from the first review round. Motivation was to pay in my
> promise to finally deliver some docs for drm_mm, but it went a bit beyond this
> ;-)
>
> There's obviously still massive room for improvements, but I think this is a
> very big step forward for drm api documentation. Some of the future stuff we
> could polish:
> - Extract drm_property.c from drm_crtc.c - especially now that properties seem
>   to ramp up in usage this looks sensible. I plan to throw this in as a
>   follow-up once this here has landed (to avoid useless patch churn).
> - Sprinkle overview kerneldoc sections into the modeset core and helper code and
>   pull it into the DocBook. I've done this for a few of them, but a lot are
>   still uncovered. We could use some of the write-ups from Laurent for this and
>   move a few paragraphs from the DocBook into the source files. Imo chances are
>   much better that people actually read them.
> - There's still a few poorly-documented areas used by modern drivers. The
>   biggest one is the interrupt support and vblank code. *shudder*
> - Finally drivers completely lack docs currently, this series adds a skeleton
>   for i915. Lots of work for me and everyone at Intel in this area ;-)
>
> If you want to have a look at what the DRM Developer's Guide looks like after
> all these patches I've uploaded the html rendering to
>
> http://people.freedesktop.org/~danvet/drm/
>
> Reviews and comments highly welcome.
>
> Note that the last patch will break imx, at least the one in drm-next. I plan to
> send a pull request with all these to Dave excluding that last patch after I've
> applied the review feedback.
>

Nice work!

Series is:

Reviewed-by: Alex Deucher <alexander.deucher at amd.com>

> Cheers, Daniel
>
> Daniel Vetter (34):
>   drm/doc: Clarify the dumb object interfaces
>   drm/doc: Fix up kerneldoc in drm_edid.c
>   drm/doc: Clean up and integrate kerneldoc for drm_gem.c
>   drm/doc: Remove <term> from rendernode docs
>   drm/doc: Reorganize driver documentation
>   drm/doc: Move the vma offset manager to the right spot
>   drm/doc: Remove the "command submissin and fencing" section
>   drm/doc: No more drm perf counters
>   drm/doc: Document drm_helper_resume_force_mode
>   drm/doc: Hide legacy horrors better
>   drm/docs: Include hdmi infoframe helper reference
>   drm/doc: Clarify PRIME documentation
>   drm/doc: Add PRIME function references
>   drm/doc: Update copyright
>   drm/mm: Remove MM_UNUSED_TARGET
>   drm/doc: Overview documentation for drm_mm.c
>   drm/doc: Add fucntion reference documentation for drm_mm.c
>   drm/kms: rip out drm_mode_connector_detach_encoder
>   drm/doc: Integrate drm_modes.c kerneldoc
>   drm/doc: Repleace LOCKING kerneldoc sections in drm_modes.c
>   drm: move drm_mode related functions into drm_modes.c
>   drm: extract drm_modes.h for drm_modes.c functions
>   drm/modes: remove drm_mode_height/width
>   drm/modes: drop return value from drm_display_mode_from_videomode
>   drm/modes: drop maxPitch from drm_mode_validate_size
>   drm: polish function kerneldoc for drm_modes.[hc]
>   drm: remove drm_display_mode->private_size
>   drm/doc: Fix misplaced </para>
>   drm: remove return value from drm_helper_mode_fill_fb_struct
>   drm/crtc-helper: remove LOCKING from kerneldoc
>   drm: drop error code for drm_helper_resume_force_mode
>   drm: kerneldoc polish for drm_crtc_helper.c
>   drm: kerneldoc polish for drm_crtc.c
>   drm/kms: don't export drm_mode_group_init_legacy_group
>
>  Documentation/DocBook/drm.tmpl             | 500 ++++++++++++++-------
>  drivers/gpu/drm/drm_crtc.c                 | 698 ++++++++++++++++++++++++-----
>  drivers/gpu/drm/drm_crtc_helper.c          | 193 ++++++--
>  drivers/gpu/drm/drm_crtc_internal.h        |  38 ++
>  drivers/gpu/drm/drm_edid.c                 |  30 +-
>  drivers/gpu/drm/drm_fb_helper.c            |   4 +-
>  drivers/gpu/drm/drm_gem.c                  |  63 ++-
>  drivers/gpu/drm/drm_mm.c                   | 211 ++++++++-
>  drivers/gpu/drm/drm_modes.c                | 346 +++++++-------
>  drivers/gpu/drm/drm_prime.c                | 110 ++++-
>  drivers/staging/imx-drm/imx-ldb.c          |   2 -
>  drivers/staging/imx-drm/parallel-display.c |   2 -
>  include/drm/drmP.h                         |  29 --
>  include/drm/drm_crtc.h                     | 174 +------
>  include/drm/drm_crtc_helper.h              |   6 +-
>  include/drm/drm_mm.h                       | 154 +++++--
>  include/drm/drm_modes.h                    | 237 ++++++++++
>  include/linux/hdmi.h                       |  12 +
>  18 files changed, 2013 insertions(+), 796 deletions(-)
>  create mode 100644 drivers/gpu/drm/drm_crtc_internal.h
>  create mode 100644 include/drm/drm_modes.h
>
> --
> 1.8.5.2
>
> _______________________________________________
> dri-devel mailing list
> dri-devel at lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/dri-devel