drm/doc: Document kapi doc expectations
authorDaniel Vetter <daniel.vetter@ffwll.ch>
Thu, 4 Jul 2019 14:50:54 +0000 (16:50 +0200)
committerDaniel Vetter <daniel.vetter@ffwll.ch>
Fri, 19 Jul 2019 13:02:37 +0000 (15:02 +0200)
We've had this already for anything new. With my drm_prime.c cleanup I
also think documentation for everything already existing is complete,
and we can bake this in as a requirements subsystem wide.

v2: Improve wording a bit (Laurent), fix typo in commit message (Sam).

Acked-by: Emil Velikov <emil.velikov@collabora.com>
Acked-by: Sean Paul <sean@poorly.run>
Acked-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Acked-by: Maxime Ripard <maxime.ripard@bootlin.com>
Acked-by: Sam Ravnborg <sam@ravnborg.org>
Acked-by: Jani Nikula <jani.nikula@intel.com>
Acked-by: Alex Deucher <alexdeucher@gmail.com>
Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
Cc: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Cc: Jani Nikula <jani.nikula@linux.intel.com>
Cc: David Airlie <airlied@linux.ie>
Cc: Daniel Vetter <daniel@ffwll.ch>
Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
Cc: Maxime Ripard <maxime.ripard@bootlin.com>
Cc: Sean Paul <sean@poorly.run>
Link: https://patchwork.freedesktop.org/patch/msgid/20190704145054.5701-1-daniel.vetter@ffwll.ch

index fccbe375244d8c10767f83b4d6da4ac09366022f..25a56e9c0cfdc1cebea3421034125b573fad1a23 100644 (file)
@@ -51,6 +51,22 @@ and "FIXME" where the interface could be cleaned up.
 Also read the :ref:`guidelines for the kernel documentation at large <doc_guide>`.
+Documentation Requirements for kAPI
+All kernel APIs exported to other modules must be documented, including their
+datastructures and at least a short introductory section explaining the overall
+concepts. Documentation should be put into the code itself as kerneldoc comments
+as much as reasonable.
+Do not blindly document everything, but document only what's relevant for driver
+authors: Internal functions of drm.ko and definitely static functions should not
+have formal kerneldoc comments. Use normal C comments if you feel like a comment
+is warranted. You may use kerneldoc syntax in the comment, but it shall not
+start with a /** kerneldoc marker. Similar for data structures, annotate
+anything entirely private with ``/* private: */`` comments as per the
+documentation guide.
 Getting Started
index 3f6ecf84626364e85b45bd4d4c2df408fc045755..a38639e96e8b6cda1a9945abcdaed1c2a9772592 100644 (file)
@@ -308,19 +308,6 @@ In the end no .c file should need to include ``drmP.h`` anymore.
 Contact: Daniel Vetter
-Add missing kerneldoc for exported functions
-The DRM reference documentation is still lacking kerneldoc in a few areas. The
-task would be to clean up interfaces like moving functions around between
-files to better group them and improving the interfaces like dropping return
-values for functions that never fail. Then write kerneldoc for all exported
-functions and an overview section and integrate it all into the drm book.
-See https://dri.freedesktop.org/docs/drm/ for what's there already.
-Contact: Daniel Vetter
 Make panic handling work