Commit 1ea35768 authored by Daniel Vetter's avatar Daniel Vetter
Browse files

drm/doc: Consistent kerneldoc include order 



First overview text (if there is any), then headers (since generally
you want to start out with the data structures), then all the other
stuff with functions.

Most of this is pre-shpinx, since with the old docbook only the
overview stuff was pulled in directly. Everything else was put in a
per-section index, so include order didn't really matter.

Acked-by: default avatarEric Anholt <eric@anholt.net>
Signed-off-by: default avatarDaniel Vetter <daniel.vetter@intel.com>
Link: http://patchwork.freedesktop.org/patch/msgid/20170302151638.1882-4-daniel.vetter@ffwll.ch
parent 2564d0b0

Documentation/gpu/drm-internals.rst

+3 −3
Original line number Diff line number Diff line
@@ -140,12 +140,12 @@ Device Instance and Driver Handling 
.. kernel-doc:: drivers/gpu/drm/drm_drv.c

   :doc: driver instance overview



.. kernel-doc:: drivers/gpu/drm/drm_drv.c

   :export:



.. kernel-doc:: include/drm/drm_drv.h

   :internal:



.. kernel-doc:: drivers/gpu/drm/drm_drv.c

   :export:



Driver Load

-----------

Documentation/gpu/drm-kms-helpers.rst

+11 −11
Original line number Diff line number Diff line
@@ -37,10 +37,10 @@ Modeset Helper Reference for Common Vtables 
===========================================



.. kernel-doc:: include/drm/drm_modeset_helper_vtables.h

   :internal:

   :doc: overview



.. kernel-doc:: include/drm/drm_modeset_helper_vtables.h

   :doc: overview

   :internal:



Atomic Modeset Helper Functions Reference

=========================================
@@ -84,27 +84,27 @@ Legacy CRTC/Modeset Helper Functions Reference 
Simple KMS Helper Reference

===========================



.. kernel-doc:: drivers/gpu/drm/drm_simple_kms_helper.c

   :doc: overview



.. kernel-doc:: include/drm/drm_simple_kms_helper.h

   :internal:



.. kernel-doc:: drivers/gpu/drm/drm_simple_kms_helper.c

   :export:



.. kernel-doc:: drivers/gpu/drm/drm_simple_kms_helper.c

   :doc: overview



fbdev Helper Functions Reference

================================



.. kernel-doc:: drivers/gpu/drm/drm_fb_helper.c

   :doc: fbdev helpers



.. kernel-doc:: drivers/gpu/drm/drm_fb_helper.c

   :export:



.. kernel-doc:: include/drm/drm_fb_helper.h

   :internal:



.. kernel-doc:: drivers/gpu/drm/drm_fb_helper.c

   :export:



Framebuffer CMA Helper Functions Reference

==========================================
@@ -146,15 +146,15 @@ Bridge Helper Reference 
Panel Helper Reference

======================



.. kernel-doc:: drivers/gpu/drm/drm_panel.c

   :doc: drm panel



.. kernel-doc:: include/drm/drm_panel.h

   :internal:



.. kernel-doc:: drivers/gpu/drm/drm_panel.c

   :export:



.. kernel-doc:: drivers/gpu/drm/drm_panel.c

   :doc: drm panel



Display Port Helper Functions Reference

=======================================

Documentation/gpu/drm-kms.rst

+12 −12
Original line number Diff line number Diff line
@@ -152,12 +152,12 @@ panels are still in-flux and not really fully sorted out yet. 
KMS Core Structures and Functions

=================================



.. kernel-doc:: drivers/gpu/drm/drm_mode_config.c

   :export:



.. kernel-doc:: include/drm/drm_mode_config.h

   :internal:



.. kernel-doc:: drivers/gpu/drm/drm_mode_config.c

   :export:



Modeset Base Object Abstraction

===============================
@@ -170,12 +170,12 @@ Modeset Base Object Abstraction 
Atomic Mode Setting Function Reference

======================================



.. kernel-doc:: drivers/gpu/drm/drm_atomic.c

   :export:



.. kernel-doc:: include/drm/drm_atomic.h

   :internal:



.. kernel-doc:: drivers/gpu/drm/drm_atomic.c

   :export:



CRTC Abstraction

================
@@ -200,12 +200,12 @@ Frame Buffer Abstraction 
Frame Buffer Functions Reference

--------------------------------



.. kernel-doc:: drivers/gpu/drm/drm_framebuffer.c

   :export:



.. kernel-doc:: include/drm/drm_framebuffer.h

   :internal:



.. kernel-doc:: drivers/gpu/drm/drm_framebuffer.c

   :export:



DRM Format Handling

===================
@@ -508,8 +508,8 @@ operation handler. 
Vertical Blanking and Interrupt Handling Functions Reference

------------------------------------------------------------



.. kernel-doc:: drivers/gpu/drm/drm_irq.c

   :export:



.. kernel-doc:: include/drm/drm_irq.h

   :internal:



.. kernel-doc:: drivers/gpu/drm/drm_irq.c

   :export:

Documentation/gpu/drm-mm.rst

+12 −12
Original line number Diff line number Diff line
@@ -365,36 +365,36 @@ from the client in libdrm. 
GEM Function Reference

----------------------



.. kernel-doc:: drivers/gpu/drm/drm_gem.c

   :export:



.. kernel-doc:: include/drm/drm_gem.h

   :internal:



.. kernel-doc:: drivers/gpu/drm/drm_gem.c

   :export:



GEM CMA Helper Functions Reference

----------------------------------



.. kernel-doc:: drivers/gpu/drm/drm_gem_cma_helper.c

   :doc: cma helpers



.. kernel-doc:: drivers/gpu/drm/drm_gem_cma_helper.c

   :export:



.. kernel-doc:: include/drm/drm_gem_cma_helper.h

   :internal:



.. kernel-doc:: drivers/gpu/drm/drm_gem_cma_helper.c

   :export:



VMA Offset Manager

==================



.. kernel-doc:: drivers/gpu/drm/drm_vma_manager.c

   :doc: vma offset manager



.. kernel-doc:: drivers/gpu/drm/drm_vma_manager.c

   :export:



.. kernel-doc:: include/drm/drm_vma_manager.h

   :internal:



.. kernel-doc:: drivers/gpu/drm/drm_vma_manager.c

   :export:



PRIME Buffer Sharing

====================
@@ -473,12 +473,12 @@ LRU Scan/Eviction Support 
DRM MM Range Allocator Function References

------------------------------------------



.. kernel-doc:: drivers/gpu/drm/drm_mm.c

   :export:



.. kernel-doc:: include/drm/drm_mm.h

   :internal:



.. kernel-doc:: drivers/gpu/drm/drm_mm.c

   :export:



DRM Cache Handling

==================

CRA Git | Maintained and supported by SUSTech CRA and CCSE