change system file

hc

2024-10-09 244b2c5ca8b14627e4a17755e5922221e121c771

 kernel/Documentation/gpu/introduction.rst
..
..
@@ -51,6 +51,22 @@
51
51
 
52
52
 Also read the :ref:`guidelines for the kernel documentation at large <doc_guide>`.
53
53
 
54
+Documentation Requirements for kAPI
55
+-----------------------------------
56
+
57
+All kernel APIs exported to other modules must be documented, including their
58
+datastructures and at least a short introductory section explaining the overall
59
+concepts. Documentation should be put into the code itself as kerneldoc comments
60
+as much as reasonable.
61
+
62
+Do not blindly document everything, but document only what's relevant for driver
63
+authors: Internal functions of drm.ko and definitely static functions should not
64
+have formal kerneldoc comments. Use normal C comments if you feel like a comment
65
+is warranted. You may use kerneldoc syntax in the comment, but it shall not
66
+start with a /** kerneldoc marker. Similar for data structures, annotate
67
+anything entirely private with ``/* private: */`` comments as per the
68
+documentation guide.
69
+
54
70
 Getting Started
55
71
 ===============
56
72