[PATCH 00/15] bunch of kerneldocs polish and related cleanup

Daniel Vetter daniel.vetter at ffwll.ch
Mon Jul 9 08:40:01 UTC 2018


Hi all,

For anything somewhat complicated the in-line kerneldoc comments for
struct members are much, much better. But we still have plenty of
old-style stuff around, tricking people into writing way too short docs
that don't explain stuff.

This series moves drm_connector|crtc|plane(_state) over to inline comments
comopletely. Plus some related cleanups.

Review and comments very much welcome!

Cheers, Daniel

Daniel Vetter (15):
  drm: move drv test macros out of drmP.h
  drm: Drop drmP.h from drm_connector.c
  drm/doc: switch drm_connector_state to inline comments
  drm/doc: polish for sturct drm_connector
  drm: drop _mode_ from update_edit_property()
  drm: drop _mode_ from drm_mode_connector_attach_encoder
  drm: drop _mode_ from remaining connector functions
  drm: Switch drm_plane_state to inline kerneldoc style
  drm: switch drm_plane to inline comments
  drm: drop drmP.h include from drm_plane.c
  drm/doc: move struct drm_crtc to in-line comments
  drm/doc: Group the fb gem helpers better
  drm/doc: Includ drm_of.c helpers
  drm/doc: use inline kerneldoc style for drm_crtc_state
  drm: drop drmP.h include from drm_crtc.c

 Documentation/gpu/drm-kms-helpers.rst         |  17 +-
 Documentation/gpu/drm-kms.rst                 |  13 +-
 .../gpu/drm/amd/amdgpu/amdgpu_connectors.c    |   4 +-
 drivers/gpu/drm/amd/amdgpu/amdgpu_encoders.c  |   2 +-
 drivers/gpu/drm/amd/amdgpu/dce_virtual.c      |   2 +-
 .../gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.c |   6 +-
 .../display/amdgpu_dm/amdgpu_dm_mst_types.c   |  10 +-
 drivers/gpu/drm/arc/arcpgu_sim.c              |   2 +-
 drivers/gpu/drm/ast/ast_mode.c                |   6 +-
 drivers/gpu/drm/bochs/bochs_kms.c             |   2 +-
 drivers/gpu/drm/bridge/adv7511/adv7511_drv.c  |   4 +-
 drivers/gpu/drm/bridge/analogix-anx78xx.c     |   8 +-
 .../drm/bridge/analogix/analogix_dp_core.c    |   6 +-
 drivers/gpu/drm/bridge/dumb-vga-dac.c         |   4 +-
 .../bridge/megachips-stdpxxxx-ge-b850v3-fw.c  |   4 +-
 drivers/gpu/drm/bridge/nxp-ptn3460.c          |   4 +-
 drivers/gpu/drm/bridge/panel.c                |   2 +-
 drivers/gpu/drm/bridge/parade-ps8622.c        |   2 +-
 drivers/gpu/drm/bridge/sii902x.c              |   4 +-
 drivers/gpu/drm/bridge/synopsys/dw-hdmi.c     |   4 +-
 drivers/gpu/drm/bridge/tc358767.c             |   4 +-
 drivers/gpu/drm/bridge/ti-tfp410.c            |   4 +-
 drivers/gpu/drm/cirrus/cirrus_mode.c          |   2 +-
 drivers/gpu/drm/drm_atomic_helper.c           |   2 +-
 drivers/gpu/drm/drm_connector.c               |  60 +++--
 drivers/gpu/drm/drm_crtc.c                    |   5 +-
 drivers/gpu/drm/drm_crtc_internal.h           |  14 +-
 drivers/gpu/drm/drm_debugfs.c                 |   4 +-
 drivers/gpu/drm/drm_dp_mst_topology.c         |   4 +-
 drivers/gpu/drm/drm_internal.h                |   5 +
 drivers/gpu/drm/drm_ioctl.c                   |   2 +-
 drivers/gpu/drm/drm_mode_object.c             |   3 +-
 drivers/gpu/drm/drm_modes.c                   |   6 +-
 drivers/gpu/drm/drm_of.c                      |   9 +-
 drivers/gpu/drm/drm_plane.c                   |  11 +-
 drivers/gpu/drm/drm_probe_helper.c            |   6 +-
 drivers/gpu/drm/drm_simple_kms_helper.c       |   2 +-
 drivers/gpu/drm/drm_writeback.c               |   2 +-
 drivers/gpu/drm/exynos/exynos_drm_dpi.c       |   2 +-
 drivers/gpu/drm/exynos/exynos_drm_dsi.c       |   2 +-
 drivers/gpu/drm/exynos/exynos_drm_vidi.c      |   4 +-
 drivers/gpu/drm/exynos/exynos_hdmi.c          |   4 +-
 drivers/gpu/drm/fsl-dcu/fsl_dcu_drm_rgb.c     |   2 +-
 drivers/gpu/drm/gma500/cdv_intel_dp.c         |   2 +-
 drivers/gpu/drm/gma500/cdv_intel_hdmi.c       |   2 +-
 drivers/gpu/drm/gma500/gma_display.c          |   2 +-
 drivers/gpu/drm/gma500/mdfld_dsi_dpi.c        |   2 +-
 drivers/gpu/drm/gma500/oaktrail_hdmi.c        |   2 +-
 drivers/gpu/drm/gma500/oaktrail_lvds.c        |   2 +-
 drivers/gpu/drm/gma500/psb_intel_modes.c      |   2 +-
 drivers/gpu/drm/gma500/psb_intel_sdvo.c       |   2 +-
 .../gpu/drm/hisilicon/hibmc/hibmc_drm_vdac.c  |   2 +-
 drivers/gpu/drm/i2c/tda998x_drv.c             |   4 +-
 drivers/gpu/drm/i915/intel_display.c          |   3 +-
 drivers/gpu/drm/i915/intel_dp.c               |   6 +-
 drivers/gpu/drm/i915/intel_dp_mst.c           |   5 +-
 drivers/gpu/drm/i915/intel_lvds.c             |   2 +-
 drivers/gpu/drm/i915/intel_modes.c            |   2 +-
 drivers/gpu/drm/i915/intel_sdvo.c             |   2 +-
 drivers/gpu/drm/imx/imx-ldb.c                 |   5 +-
 drivers/gpu/drm/imx/imx-tve.c                 |   4 +-
 drivers/gpu/drm/imx/parallel-display.c        |   4 +-
 drivers/gpu/drm/mediatek/mtk_dsi.c            |   2 +-
 drivers/gpu/drm/mediatek/mtk_hdmi.c           |   4 +-
 drivers/gpu/drm/meson/meson_venc_cvbs.c       |   2 +-
 drivers/gpu/drm/mgag200/mgag200_mode.c        |   4 +-
 .../drm/msm/disp/mdp4/mdp4_lvds_connector.c   |   2 +-
 drivers/gpu/drm/msm/dsi/dsi_manager.c         |   4 +-
 drivers/gpu/drm/msm/edp/edp_connector.c       |   4 +-
 drivers/gpu/drm/msm/hdmi/hdmi_connector.c     |   4 +-
 drivers/gpu/drm/nouveau/dispnv04/dac.c        |   2 +-
 drivers/gpu/drm/nouveau/dispnv04/dfp.c        |   2 +-
 drivers/gpu/drm/nouveau/dispnv04/tvnv04.c     |   2 +-
 drivers/gpu/drm/nouveau/dispnv04/tvnv17.c     |   2 +-
 drivers/gpu/drm/nouveau/dispnv50/disp.c       |  12 +-
 drivers/gpu/drm/nouveau/nouveau_connector.c   |   8 +-
 drivers/gpu/drm/omapdrm/omap_connector.c      |   4 +-
 drivers/gpu/drm/omapdrm/omap_drv.c            |   2 +-
 drivers/gpu/drm/panel/panel-simple.c          |   2 +-
 drivers/gpu/drm/qxl/qxl_display.c             |   2 +-
 drivers/gpu/drm/radeon/radeon_connectors.c    |   4 +-
 drivers/gpu/drm/radeon/radeon_dp_mst.c        |   6 +-
 drivers/gpu/drm/radeon/radeon_encoders.c      |   2 +-
 drivers/gpu/drm/rcar-du/rcar_lvds.c           |   2 +-
 drivers/gpu/drm/rockchip/cdn-dp-core.c        |   4 +-
 drivers/gpu/drm/rockchip/dw-mipi-dsi.c        |   2 +-
 drivers/gpu/drm/rockchip/inno_hdmi.c          |   4 +-
 drivers/gpu/drm/rockchip/rockchip_lvds.c      |   2 +-
 drivers/gpu/drm/shmobile/shmob_drm_crtc.c     |   2 +-
 drivers/gpu/drm/sti/sti_dvo.c                 |   2 +-
 drivers/gpu/drm/sti/sti_hda.c                 |   2 +-
 drivers/gpu/drm/sti/sti_hdmi.c                |   4 +-
 drivers/gpu/drm/sun4i/sun4i_hdmi_enc.c        |   4 +-
 drivers/gpu/drm/sun4i/sun4i_lvds.c            |   2 +-
 drivers/gpu/drm/sun4i/sun4i_rgb.c             |   2 +-
 drivers/gpu/drm/sun4i/sun4i_tv.c              |   2 +-
 drivers/gpu/drm/sun4i/sun6i_mipi_dsi.c        |   2 +-
 drivers/gpu/drm/tegra/dsi.c                   |   2 +-
 drivers/gpu/drm/tegra/hdmi.c                  |   2 +-
 drivers/gpu/drm/tegra/output.c                |   2 +-
 drivers/gpu/drm/tegra/rgb.c                   |   2 +-
 drivers/gpu/drm/tegra/sor.c                   |   2 +-
 drivers/gpu/drm/tilcdc/tilcdc_panel.c         |   2 +-
 drivers/gpu/drm/tilcdc/tilcdc_tfp410.c        |   4 +-
 drivers/gpu/drm/udl/udl_connector.c           |   4 +-
 drivers/gpu/drm/vc4/vc4_hdmi.c                |   4 +-
 drivers/gpu/drm/vc4/vc4_vec.c                 |   2 +-
 drivers/gpu/drm/virtio/virtgpu_display.c      |   2 +-
 drivers/gpu/drm/vkms/vkms_output.c            |   2 +-
 drivers/gpu/drm/vmwgfx/vmwgfx_kms.c           |   2 +-
 drivers/gpu/drm/vmwgfx/vmwgfx_ldu.c           |   2 +-
 drivers/gpu/drm/vmwgfx/vmwgfx_scrn.c          |   2 +-
 drivers/gpu/drm/vmwgfx/vmwgfx_stdu.c          |   2 +-
 drivers/gpu/drm/zte/zx_hdmi.c                 |   4 +-
 drivers/gpu/drm/zte/zx_tvenc.c                |   2 +-
 drivers/gpu/drm/zte/zx_vga.c                  |   4 +-
 drivers/staging/vboxvideo/vbox_mode.c         |   4 +-
 include/drm/drmP.h                            |  19 --
 include/drm/drm_color_mgmt.h                  |   1 +
 include/drm/drm_connector.h                   | 221 ++++++++++------
 include/drm/drm_crtc.h                        | 240 ++++++++++++++----
 include/drm/drm_drv.h                         |  29 +++
 include/drm/drm_modes.h                       |   2 +-
 include/drm/drm_modeset_helper_vtables.h      |   2 +-
 include/drm/drm_plane.h                       | 176 +++++++++----
 include/drm/drm_property.h                    |   2 +
 126 files changed, 742 insertions(+), 434 deletions(-)

-- 
2.18.0



More information about the dri-devel mailing list